Sign in
E-Invoicing

Update an e-invoicing service provider

Updates information about an e-invoicing service privider.

Note: This operation is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

put/v1/einvoice/service-providers/{key}

Path parameters

keystring required

The unique ID or number of the e-invoicing service provider that you want to update.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

companyIdentifierstring

The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.

namestring

The name of the e-invoicing service provider.

testboolean

Whether the e-invoicing service provider's configuration is intended for testing.

  • If you set this field to true, requests are directed to the testing integration endpoints.
  • If you set this field to false, requests are directed to the production integration endpoints.
apiKeystring

The API key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider.

secretKeystring

The secret key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider.

use_certificateboolean

This field is used to indicate whether the clientCertificate, clientCertificateType, and clientCertificatePassord fields need to be supplied in the request.

Note: If the flag is true, the TLS endpoint config is enabled. If the flag is false, the Non-TLS config endpoint is enabled. A TLS certificate and password are no longer required for integration with Sovos. Zuora now uses token-based authentication for all supported countries, including India.

clientCertificatestring byte

The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field only applies to the Sovos service provider.

clientCertificateTypestring

The client certificate type is used to specify the type of the client certificate. This field only applies to the Sovos service provider.

clientCertificatePasswordstring password

The client certificate password is the password to protect the client certificate. This field only applies to the Sovos service provider.

Example request

{
  "name": "Sovos e-invoice service",
  "test": false,
  "companyIdentifier": "CompanySample1",
  "apiKey": "ApiKeySample",
  "secretKey": "SecretKey",
  "use_certificate": false,
  "clientCertificate": "U3dhZ2dlciByb2Nrcw==",
  "clientCertificateType": "PKCS12",
  "clientCertificatePassword": "ClientCertificatePassword"
}

Response

OK

companyIdentifierstring

The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.

idstring

The ID of the e-invoicing service provider.

namestring

The name of the e-invoicing service provider.

provider'Sovos' | 'PEPPOL' | 'Avalara'

The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents.

serviceProviderNumberstring

The unique number of the e-invoicing service provider.

testboolean

Whether the e-invoicing service provider's configuration is intended for testing.

  • If you set this field to true, requests are directed to the testing integration endpoints.
  • If you set this field to false, requests are directed to the production integration endpoints.
apiKeystring

The API key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider.

use_certificateboolean

This field is used to indicate whether the clientCertificate, clientCertificateType, and clientCertificatePassord fields need to be supplied in the request.

Note: If the flag is true, the TLS endpoint config is enabled. If the flag is false, the Non-TLS config endpoint is enabled. A TLS certificate and password are no longer required for integration with Sovos. Zuora now uses token-based authentication for all supported countries, including India.

clientCertificatestring byte

The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field only applies to the Sovos service provider.

clientCertificateTypestring

The client certificate type is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos service provider.

Changes