Skip to content

Create Address#

Create Address API is used to create an Address using the given request payload.

Route

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

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

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": "27AABBB1122CZ1O",
    "gstService": "einvoice",
    "recipientEmails": "abc@def.com",
    "recipientApplicationEndpoint": null,
    "encryptionPublicKey": null
  },
  {
    "identifier": "27AABBB1123CZ1O",
    "gstService": "einvoice",
    "recipientEmails": "abc@def.com",
    "recipientApplicationEndpoint": null,
    "encryptionPublicKey": null
  },
  {
    "identifier": "27AABBB1124CZ1O",
    "gstService": "einvoice",
    "recipientEmails": "abc@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": "4b935b99-b16d-4c89-815c-224716ce8d14",
          "identifier": "27AABBB1122CZ1O",
          "gstService": "einvoice",
          "emailEndpoints": "abc@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": 1662804192150,
          "lastUpdated": 1662804192150
        },
        "itemErrors": null,
        "itemInfoDetails": null
      },
      {
        "itemStatus": "1",
        "itemData": {
          "id": "b1f23c5b-ea15-4f8f-b1b4-c97a7518d6f8",
          "identifier": "27AABBB1123CZ1O",
          "gstService": "einvoice",
          "emailEndpoints": "abc@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": 1662804192157,
          "lastUpdated": 1662804192157
        },
        "itemErrors": null,
        "itemInfoDetails": null
      },
      {
        "itemStatus": "1",
        "itemData": {
          "id": "04aa17e5-a5d2-49af-ba72-d786500a7dc9",
          "identifier": "27AABBB1124CZ1O",
          "gstService": "einvoice",
          "emailEndpoints": "abc@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": 1662804192164,
          "lastUpdated": 1662804192164
        },
        "itemErrors": null,
        "itemInfoDetails": null
      }
    ],
    "errors": null,
    "infoDetails": null
  }
}

Last update: September 10, 2022