Skip to content

Update Address#

Update Address API is used to update an Address using the given request payload.

Route

invxb/apis/{banners-version}/orgs/{org-id}/addresses

- active 'banners-version': v1
- method: PATCH

URL Parameters#

Name Description Type
banners-version version of the API
for example, v1		 string
org-id theodore organisation id string

Request#

Please refer the following request body for reference-

Sample request body

[
  {
    "identifier": "37AABBB1124CZ1O",
    "gstService": "einvoice",
    "recipientEmails": "xyz@def.com",
    "recipientApplicationEndpoint": null,
    "encryptionPublicKey": null
  },
  {
    "identifier": "37AABBB1125CZ1O",
    "gstService": "einvoice",
    "recipientEmails": "xyz@def.com",
    "recipientApplicationEndpoint": null,
    "encryptionPublicKey": null
  }
]

Response#

Successful response will have the response in “data” attribute as a json.

200#

Sample response body

{
  "data": {
    "status": "1",
    "data": [
      {
        "itemStatus": "1",
        "itemData": {
          "id": "952afa5c-b0c3-41a6-abb7-0f21f9737947",
          "identifier": "37AABBB1124CZ1O",
          "gstService": "einvoice",
          "emailEndpoints": "xyz@def.com",
          "restEndpoint": null,
          "registeredByOrg": {
            "id": "0d1c5ac7-3fdd-495c-ac19-196d7337d491",
            "name": "Organisation A LLP",
            "taxIdentifier": "ORGAA1234K",
            "taxIdentifierType": "PAN",
            "country": "India",
            "tz": "Asia/Kolkata",
            "locale": "en_US"
          },
          "publicKey": null,
          "createdOn": 1662804184778,
          "lastUpdated": 1662804184778
        },
        "itemErrors": null,
        "itemInfoDetails": null
      },
      {
        "itemStatus": "1",
        "itemData": {
          "id": "1cebc59b-bd11-466b-900f-76f6b5f1dc9f",
          "identifier": "37AABBB1125CZ1O",
          "gstService": "einvoice",
          "emailEndpoints": "xyz@def.com",
          "restEndpoint": null,
          "registeredByOrg": {
            "id": "0d1c5ac7-3fdd-495c-ac19-196d7337d491",
            "name": "Organisation A LLP",
            "taxIdentifier": "ORGAA1234K",
            "taxIdentifierType": "PAN",
            "country": "India",
            "tz": "Asia/Kolkata",
            "locale": "en_US"
          },
          "publicKey": null,
          "createdOn": 1662804184784,
          "lastUpdated": 1662804184784
        },
        "itemErrors": null,
        "itemInfoDetails": null
      }
    ],
    "errors": null,
    "infoDetails": null
  }
}
Last update: September 10, 2022