Skip to main content

Create Logo Settings

POST /api/v1/InvoiceSetting/createLogo

Description​

This endpoint is used to create a new logo setting. It allows users to define and configure a new logo for invoices.

Headers:

  • Content-Type: application/json

ApiKey:

  • No API key required

Path Parameters:

  • version: string, required

Request Body:

  • CreateInvoiceLogoSettingsRequest object containing the new logo settings

URL:

  • POST: {{baseUrl API url}}/api/v1/InvoiceSetting/createLogo

Response:

  • 200: Success, indicates that the new logo settings have been successfully created.

Error Codes:

  • 400: Bad Request, the request body is not valid or missing required fields.

  • 404: Resource not found, the specified version or setting does not exist.

  • 500: Internal server error, something went wrong while processing the request.

Example Request URL:

POST /api/v1/InvoiceSetting/createLogo
Content-Type: application/json
{
  "logoPath": "path/to/logo",
  "isActive": true
}

Example Response:

HTTP/1.1 200 OK

Notes:

  • The request body should contain the CreateInvoiceLogoSettingsRequest object, which includes the new logo settings.

  • The response indicates that the new logo settings have been successfully created.

Method: POST​

/api/v1/InvoiceSetting/createLogo

Headers​

Content-TypeValue
Content-Typeapplication/json

Body (raw)​

{
  "base64": "<string>",
  "fileName": "<string>"
}

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/InvoiceSetting/createLogo \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!