@@ -1323,7 +1323,7 @@ <h2 id="scope-usage"><a name="scope-usage"></a>Scope Usage</h2>
13231323 < tr >
13241324 < td > < code class ="language-plaintext highlighter-rouge "> expense.report.tax.readwrite</ code > </ td >
13251325 < td > Read and Write information about tax details of an expense on a report.</ td >
1326- < td > GET</ td >
1326+ < td > GET/PATCH </ td >
13271327 </ tr >
13281328 </ tbody >
13291329</ table >
@@ -1499,6 +1499,109 @@ <h4 id="-response"><a name="tax-details-response-schema"></a> Response</h4>
14991499< span class ="o "> }</ span >
15001500</ code > </ pre > </ div > </ div >
15011501
1502+ < h2 id ="updates-the-tax-details-of-a-specific-expense-in-a-submitted-report- "> Updates the Tax Details of a Specific Expense in a Submitted Report < a name ="update-tax-in-expense-entry-in-a-submitted-report "> </ a > </ h2 >
1503+
1504+ < p > Updates the tax details and custom data of a specified expense on a submitted report. When calling this endpoint only Company JWT authentication is
1505+ allowed. The fields that can be updated are < code class ="language-plaintext highlighter-rouge "> taxTransactionAmount</ code > , < code class ="language-plaintext highlighter-rouge "> reclaimTransactionAmount</ code > , < code class ="language-plaintext highlighter-rouge "> reclaimCode</ code > , < code class ="language-plaintext highlighter-rouge "> customData</ code > , and< code class ="language-plaintext highlighter-rouge "> taxCode</ code > .</ p >
1506+
1507+ < h3 id ="scopes-1 "> Scopes</ h3 >
1508+
1509+ < ul >
1510+ < li > < code class ="language-plaintext highlighter-rouge "> expense.report.tax.readwrite</ code > - Refer to < a href ="#scope-usage "> Scope Usage</ a > for full details.</ li >
1511+ </ ul >
1512+
1513+ < h3 id ="uri-1 "> URI</ h3 >
1514+
1515+ < div class ="language-shell highlighter-rouge "> < div class ="highlight "> < pre class ="highlight "> < code > /expensereports/v4/reports/< span class ="o "> {</ span > reportId< span class ="o "> }</ span > /expenses/< span class ="o "> {</ span > expenseId< span class ="o "> }</ span > /tax/< span class ="o "> {</ span > taxAuthorityId< span class ="o "> }</ span >
1516+ </ code > </ pre > </ div > </ div >
1517+
1518+ < h4 id ="parameters-1 "> Parameters</ h4 >
1519+
1520+ < table >
1521+ < thead >
1522+ < tr >
1523+ < th > Name</ th >
1524+ < th > Type</ th >
1525+ < th > Format</ th >
1526+ < th > Description</ th >
1527+ </ tr >
1528+ </ thead >
1529+ < tbody >
1530+ < tr >
1531+ < td > < code class ="language-plaintext highlighter-rouge "> reportId</ code > </ td >
1532+ < td > < code class ="language-plaintext highlighter-rouge "> string</ code > </ td >
1533+ < td > -</ td >
1534+ < td > < strong > Required</ strong > The unique identifier of the report to which this expense entry belongs</ td >
1535+ </ tr >
1536+ < tr >
1537+ < td > < code class ="language-plaintext highlighter-rouge "> expenseId</ code > </ td >
1538+ < td > < code class ="language-plaintext highlighter-rouge "> string</ code > </ td >
1539+ < td > -</ td >
1540+ < td > < strong > Required</ strong > The unique identifier of the expense entry that is being patched.</ td >
1541+ </ tr >
1542+ < tr >
1543+ < td > < code class ="language-plaintext highlighter-rouge "> taxAuthorityId</ code > </ td >
1544+ < td > < code class ="language-plaintext highlighter-rouge "> string</ code > </ td >
1545+ < td > -</ td >
1546+ < td > < strong > Required</ strong > The unique identifier of the tax associated with an expense entry.</ td >
1547+ </ tr >
1548+ </ tbody >
1549+ </ table >
1550+
1551+ < h4 id ="headers "> Headers</ h4 >
1552+
1553+ < ul >
1554+ < li > < a href ="https://tools.ietf.org/html/rfc7231#section-5.3.5 "> RFC 7231 Accept-Language</ a > </ li >
1555+ < li > < a href ="https://tools.ietf.org/html/rfc7231#section-3.1.1.5 "> RFC 7231 Content-Type</ a > </ li >
1556+ < li > < a href ="https://tools.ietf.org/html/rfc7231#section-3.1.2.2 "> RFC 7231 Content-Encoding</ a > </ li >
1557+ < li > < a href ="https://tools.ietf.org/html/rfc7234#section-5.2 "> RFC 7234 Cache-Control</ a > </ li >
1558+ < li > < a href ="https://tools.ietf.org/html/rfc7232#section-3.3 "> RFC 7232 If-Modified-Since</ a > </ li >
1559+ < li > < a href ="https://tools.ietf.org/html/rfc7231#section-5.3.4 "> RFC 7231 Accept-Encoding</ a > </ li >
1560+ < li > < a href ="https://tools.ietf.org/html/rfc7235#section-4.2 "> RFC 7235 Authorization</ a > - Bearer Token that identifies the caller.
1561+ This is the Company or User access token.</ li >
1562+ </ ul >
1563+
1564+ < h4 id ="rest-design-specification "> REST Design Specification</ h4 >
1565+
1566+ < p > PATCH operations in Expense Reports v4 conform to the JSON Merge Patch specification:</ p >
1567+
1568+ < ul >
1569+ < li > < a href ="https://tools.ietf.org/html/rfc7386 "> RFC 7386 Authorization - JSON Merge Patch</ a > </ li >
1570+ </ ul >
1571+
1572+ < h3 id ="payloads-1 "> Payloads</ h3 >
1573+
1574+ < ul >
1575+ < li > Request: < a href ="#update-report-expense-tax-schema "> Patch Expense Tax Schema</ a > </ li >
1576+ < li > Response: None</ li >
1577+ </ ul >
1578+
1579+ < h3 id ="examples-1 "> Examples</ h3 >
1580+
1581+ < h4 id ="request "> Request</ h4 >
1582+
1583+ < div class ="language-shell highlighter-rouge "> < div class ="highlight "> < pre class ="highlight "> < code > curl < span class ="nt "> --location</ span > < span class ="nt "> --request</ span > PATCH < span class ="s1 "> 'https://us.api.concursolutions.com/expensereports/v4/reports/52FE459784414104BA4D/expenses/A57E742BFA61994DABC964EE39677392/tax/11373416D4DC0640B6B2CDE372937C1A'</ span > < span class ="se "> \</ span >
1584+ < span class ="nt "> --header</ span > < span class ="s1 "> 'Authorization: Bearer {access_token}'</ span > < span class ="se "> \</ span >
1585+ < span class ="nt "> --header</ span > < span class ="s1 "> 'Content-Type: application/json'</ span > < span class ="se "> \</ span >
1586+ < span class ="nt "> --header</ span > < span class ="s1 "> 'Content-Type: text/plain'</ span > < span class ="se "> \</ span >
1587+ < span class ="nt "> --data-raw</ span > < span class ="s1 "> '{
1588+ "customData": [
1589+ {
1590+ "id": "custom1",
1591+ "value": "check"
1592+ }
1593+ ],
1594+ "reclaimTransactionAmount": 12,
1595+ "taxTransactionAmount": 25,
1596+ "reclaimCode": "RC7",
1597+ "taxCode": "TC7"
1598+ }'</ span >
1599+ </ code > </ pre > </ div > </ div >
1600+
1601+ < h4 id ="response "> Response</ h4 >
1602+ < div class ="language-shell highlighter-rouge "> < div class ="highlight "> < pre class ="highlight "> < code > 204 No Content
1603+ </ code > </ pre > </ div > </ div >
1604+
15021605< h2 id ="schema- "> Schema < a name ="schema "> </ a > </ h2 >
15031606
15041607< h3 id ="-expense-tax-details-response "> < a name ="expense-tax-details-schema "> </ a > Expense Tax Details Response</ h3 >
@@ -1660,6 +1763,84 @@ <h3 id="custom-data"><a name="expense-tax-custom-data-schema"></a>Custom Data</h
16601763 </ tbody >
16611764</ table >
16621765
1766+ < h4 id ="update-custom-data "> < a name ="update-expense-tax-custom-data-schema "> </ a > Update Custom Data</ h4 >
1767+
1768+ < table >
1769+ < thead >
1770+ < tr >
1771+ < th > Name</ th >
1772+ < th > Type</ th >
1773+ < th > Format</ th >
1774+ < th > Description</ th >
1775+ </ tr >
1776+ </ thead >
1777+ < tbody >
1778+ < tr >
1779+ < td > < code class ="language-plaintext highlighter-rouge "> id</ code > </ td >
1780+ < td > < code class ="language-plaintext highlighter-rouge "> string</ code > </ td >
1781+ < td > -</ td >
1782+ < td > < strong > Required</ strong > The unique identifier of the custom field. Examples: < code class ="language-plaintext highlighter-rouge "> custom1</ code > , < code class ="language-plaintext highlighter-rouge "> orgUnit1</ code > </ td >
1783+ </ tr >
1784+ < tr >
1785+ < td > < code class ="language-plaintext highlighter-rouge "> isValid</ code > </ td >
1786+ < td > < code class ="language-plaintext highlighter-rouge "> boolean</ code > </ td >
1787+ < td > < code class ="language-plaintext highlighter-rouge "> true</ code > /< code class ="language-plaintext highlighter-rouge "> false</ code > </ td >
1788+ < td > Whether the value returned is valid or not. This value is returned for custom fields of all data types and is specifically evaluated for list items to represent the current status. Default: < code class ="language-plaintext highlighter-rouge "> true</ code > </ td >
1789+ </ tr >
1790+ < tr >
1791+ < td > < code class ="language-plaintext highlighter-rouge "> value</ code > </ td >
1792+ < td > < code class ="language-plaintext highlighter-rouge "> string</ code > </ td >
1793+ < td > -</ td >
1794+ < td > The value of the custom field. This field can have values for all the supported data types such as < code class ="language-plaintext highlighter-rouge "> text</ code > , < code class ="language-plaintext highlighter-rouge "> integer</ code > , < code class ="language-plaintext highlighter-rouge "> boolean</ code > and < code class ="language-plaintext highlighter-rouge "> listItemId</ code > . Maximum length: 48 characters</ td >
1795+ </ tr >
1796+ </ tbody >
1797+ </ table >
1798+
1799+ < h3 id ="update-report-expense-tax-schema "> < a name ="update-report-expense-tax-schema "> </ a > Update Report Expense Tax Schema</ h3 >
1800+
1801+ < table >
1802+ < thead >
1803+ < tr >
1804+ < th > Name</ th >
1805+ < th > Type</ th >
1806+ < th > Format</ th >
1807+ < th > Description</ th >
1808+ </ tr >
1809+ </ thead >
1810+ < tbody >
1811+ < tr >
1812+ < td > < code class ="language-plaintext highlighter-rouge "> customData</ code > </ td >
1813+ < td > < a href ="#update-expense-tax-custom-data-schema "> < code class ="language-plaintext highlighter-rouge "> CustomData</ code > </ a > </ td >
1814+ < td > -</ td >
1815+ < td > The details from the < code class ="language-plaintext highlighter-rouge "> customData</ code > fields. These fields may not have data, depending on the configuration.</ td >
1816+ </ tr >
1817+ < tr >
1818+ < td > < code class ="language-plaintext highlighter-rouge "> taxTransactionAmount</ code > </ td >
1819+ < td > < code class ="language-plaintext highlighter-rouge "> decimal</ code > </ td >
1820+ < td > -</ td >
1821+ < td > The tax transaction amount.</ td >
1822+ </ tr >
1823+ < tr >
1824+ < td > < code class ="language-plaintext highlighter-rouge "> reclaimTransactionAmount</ code > </ td >
1825+ < td > < code class ="language-plaintext highlighter-rouge "> decimal</ code > </ td >
1826+ < td > -</ td >
1827+ < td > The reclaim transaction amount.</ td >
1828+ </ tr >
1829+ < tr >
1830+ < td > < code class ="language-plaintext highlighter-rouge "> taxCode</ code > </ td >
1831+ < td > < code class ="language-plaintext highlighter-rouge "> string</ code > </ td >
1832+ < td > -</ td >
1833+ < td > The tax code.</ td >
1834+ </ tr >
1835+ < tr >
1836+ < td > < code class ="language-plaintext highlighter-rouge "> reclaimCode</ code > </ td >
1837+ < td > < code class ="language-plaintext highlighter-rouge "> string</ code > </ td >
1838+ < td > -</ td >
1839+ < td > The reclaim code.</ td >
1840+ </ tr >
1841+ </ tbody >
1842+ </ table >
1843+
16631844< h3 id ="error-message "> < a name ="error-message-schema "> </ a > Error Message</ h3 >
16641845
16651846< table >
0 commit comments