Issue CreditNote

Endpoint

POST {{baseUrl}}/efris/credit-note

Overview

This endpoint allows users to create a credit note in the system. A credit note is typically issued to a customer to document a reduction in the amount owed, often due to returns or cancellations.

EFRIS Document Page Number: 115

Interface Name: Credit Note Application

Interface Code: T110

Request Body

The request body must be in JSON format and should include the following parameters:

generalInfo (object): Contains general information about the credit note.

oriInvoiceNo (string): The original invoice number associated with the credit note.

reasonCode (string): A code representing the reason for issuing the credit note.

reason (string): A brief description of the reason for the credit note.

invoiceApplyCategoryCode (string): The category code for applying the invoice.

remarks (string): Any additional remarks related to the credit note.

sellersReferenceNo (string): A reference number provided by the seller.

itemsBought (array of objects): A list of items that are being credited.

quantity (integer): The quantity of the item being credited.

itemCode (string): The code representing the item.

unitPrice (integer): The price per unit of the item.

OrderNumber (integer): The order number associated with the item.

taxRule (string): The tax rule applicable to the item.

This request will generate a new credit note based on the provided details, allowing for accurate tracking and management of returns or cancellations.

This endpoint allows users to create a credit note by submitting relevant information about the original invoice and the items being returned. A credit note serves as a document issued by a seller to a buyer, indicating that a certain amount has been credited to the buyer's account.

Request

Method: POST
Endpoint: {{baseUrl}}/efris/credit-note

Request Body

The request body must be in JSON format and should include the following parameters:

generalInfo: An object containing general information about the credit note.

oriInvoiceNo (string): The original invoice number related to the credit note.

reasonCode (string): A code representing the reason for issuing the credit note.

reason (string): A textual description of the reason for the credit note.

invoiceApplyCategoryCode (string): A code indicating the category to which the invoice applies.

remarks (string): Additional remarks or comments regarding the credit note.

sellersReferenceNo (string): A reference number assigned by the seller.

itemsBought: An array of objects, each representing an item that is being returned.

quantity (integer): The quantity of the item being returned.

itemCode (string): The code of the item being returned.

unitPrice (number): The price per unit of the item.

OrderNumber (integer): The order number associated with the item.

taxRule (string): The tax rule applicable to the item.

Response

The response will typically include a confirmation of the credit note creation, along with relevant details such as:

A unique identifier for the created credit note.

A status message indicating the success or failure of the operation.

Ensure that the request body adheres to the specified structure to avoid errors during processing.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Endpoint#

Overview#

Request Body#

Request#

Request Body#

Response#

Request

Responses

Endpoint

Overview

Request Body

Request

Request Body

Response