List Taxpayers
Learn about listing all taxpayers.
List all taxpayers
Endpoint | Method | Key value | Required fields |
---|---|---|---|
/config/v2/taxpayers | GET | $filter | N/A |
Returns a list of taxpayers ordered by name
. You can filter by code and name using eq
operator.
For example:
code eq 'abc', name eq 'Old Navy', code eq 'abc' and name eq 'Old Navy'.
Sample response - List taxpayers
{
"taxpayers": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "string",
"name": "string",
"partyTypeId": 0,
"note": "string",
"parentTaxpayerId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2021-01-01",
"endDate": "2021-12-01",
"adoptParentSetup": false,
"filingEntity": true,
"shippingTerms": "EXW",
"discountMappings": [
{
"discountCategory": "GENERAL_DISCOUNT",
"discountCode": "string"
}
]
}
],
"count": 0,
"truncated": true
}
Updated 3 months ago