Tax records

Tax records capture VAT or GST related tax entries for tax compliance and reporting.

List tax records

get/objects/tax/tax-record

Returns a collection with a key, ID, and link for each tax record. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/tax/tax-record/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/tax/tax-record/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a tax record
get/objects/tax/tax-record/{key}
Returns detailed information for a specified tax record.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the tax record.


 
 Example:  34
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "3",
    • "txnInformation": {
      • "txnDate": "2024-08-26",
      • "label": "Demo_bill_1111",
      • "txnType": "apbill",
      • "currency": {
        },
      • "txnId": "PR_2"
      },
    • "taxPointDate": "2024-08-26",
    • "description": "demo bill",
    • "journalEntry": {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/general-ledger/journal-entry/2"
      },
    • "sourceJournalEntryLine": {
      • "id": "6",
      • "key": "6",
      • "href": "/objects/general-ledger/journal-entry-line/6"
      },
    • "taxJournalEntryLine": {
      • "id": "8",
      • "key": "8",
      • "href": "/objects/general-ledger/journal-entry-line/8"
      },
    • "taxDetail": {
      • "key": "28",
      • "id": "CGST",
      • "taxType": "purchase",
      • "taxFiling": "reporting",
      • "taxRate": "10.00",
      • "taxUniqueId": "AU.InputCapitalPurchase.StandardAU.GST",
      • "href": "/objects/tax/tax-detail/28"
      },
    • "creditOrDebitTxn": "debit",
    • "taxType": "inputTax",
    • "sourceAmount": "800.00",
    • "taxAmount": "80.00",
    • "isFiled": false,
    • "isFromReverseTxn": false,
    • "state": "posted",
    • "customerOrVendorName": "1099 Int",
    • "dimensions": {
      • "contact": {
        },
      • "department": {
        },
      • "location": {
        }
      },
    • "taxId": "40071007326",
    • "isCredit": false,
    • "filingDate": "2024-08-26",
    • "taxReturn": {
      • "id": "61",
      • "key": "61",
      • "href": "/objects/tax/tax-return/61"
      },
    • "isReclaimable": false,
    • "capturePaymentTax": false,
    • "href": "/objects/tax/tax-record/3",
    • "audit": {
      • "modifiedDateTime": "2024-08-26T11:14:22Z",
      • "createdDateTime": "2024-08-26T11:14:22Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      }
    }
}