---
title: "Sync the e-Invoice status of a credit memo"
method: PUT
path: "/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status"
tags: ["E-Invoicing"]
---

# Sync the e-Invoice status of a credit memo

`PUT /v1/credit-memos/{creditMemoKey}/e-invoice/sync-status`

## Request

- Base URL: `https://rest.test.zuora.com`
- URL: `https://rest.test.zuora.com/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status`
- Auth: HTTP bearer

Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the credit memo.

**Note**: This API can only be invoked when the current e-Invoice status is one of:  `Processing`, `ApprovedByAuthority`, `RetrieveTimeout`, or `Failed`. If the status is different, the request will be rejected.

## Path parameters

- `creditMemoKey` string, required

## Query parameters

- `shouldIncludeAcknowledged` boolean
- `transactionId` string

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- CommonResponse
  - `processId` string: The ID of the process that handles the operation.
  - `reasons` object[]: The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string: The error code of response.
    - `message` string: The detail information of the error response
  - `requestId` string, uuid: Unique identifier of the request.
  - `success` boolean: Indicates whether the call succeeded.

## Other responses

- `500`: Internal Server Error
- `4XX`: Unauthorized

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/zuora/apis/api-reference/revisions/2deecb0dd041?raw)