SDKs

Every guide follows the same steps: install the package, configure it with your API key, send a sample payload so you can map it to GETS, submit an invoice, check its status, retrieve purchase invoices and handle errors.

The SDKs call the same API as everything else. To try a request without writing code, use the API playground.

Versions and countries

Each SDK sends invoices only for the countries it knows. It refuses any other country in sandbox and production before it sends anything.

No SDK has a country value for Oman. Oman is available in sandbox only; send its invoices with the API, as shown in the Oman examples.

Install the exact version a guide names.

Response formats

Unify answers in one of two formats, depending on the request. A request with the new-api: true header uses the current format. A request without it uses the earlier format.

The current format is described in Submit and retrieve. A validated invoice returns documentId at the top level, and an invoice that fails validation returns HTTP 422 with an errors list.

The earlier format always wraps the result in status, message and data, even when the invoice fails validation:

{
  "status": "success",
  "message": "Unify processing completed successfully",
  "data": {
    "document": {
      "documentId": "01K5EXAMPLE00000000000142",
      "documentNumber": "INV-2026-0142"
    },
    "validation": {
      "success": false,
      "errors": [
        {
          "code": "GETS-LINE-005",
          "message": "Line item price is required",
          "path": ["lineItems", 0, "price", "amount"]
        }
      ]
    }
  }
}

A sample payload sent for mapping has no document or validation; message is Unify request processed successfully.