Skip to content
Mengi Cloud Mengi Cloud Docs

Update Invoice Settings

PATCH
/organizations/{org_slug}/invoice-settings
 
curl --request PATCH \
  --url https://api.mengi.cloud/organizations/example/invoice-settings \
  --header 'Content-Type: application/json' \
  --data '{ "company_name": "example", "contact_email": "hello@example.com", "address_line1": "example", "address_line2": "example", "city": "example", "postal_code": "example", "country_code": "example", "vat_number": "example" }'

Update invoice settings for an organization.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_slug
required
Org Slug
string

Request Body required

Section titled “Request Body required ”
Media type application/json
InvoiceSettingsUpdate

Schema for updating invoice settings (all fields optional).

object
company_name
Any of:
string
<= 255 characters
contact_email
Any of:
string format: email
address_line1
Any of:
string
>= 1 characters <= 255 characters
address_line2
Any of:
string
<= 255 characters
city
Any of:
string
>= 1 characters <= 100 characters
postal_code
Any of:
string
>= 1 characters <= 20 characters
country_code
Any of:
string
>= 2 characters <= 2 characters
vat_number
Any of:
string
<= 50 characters
Example generated
{
  "company_name": "example",
  "contact_email": "hello@example.com",
  "address_line1": "example",
  "address_line2": "example",
  "city": "example",
  "postal_code": "example",
  "country_code": "example",
  "vat_number": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
InvoiceSettingsResponse

Schema for invoice settings response.

object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
company_name
required
Any of:
string
contact_email
required
Contact Email
string
address_line1
required
Address Line1
string
address_line2
required
Any of:
string
city
required
City
string
postal_code
required
Postal Code
string
country_code
required
Country Code
string
country_name
Any of:
string
vat_number
required
Any of:
string
vat_number_verified
required
Vat Number Verified
boolean
vat_number_verified_at
required
Any of:
string format: date-time
vat_verification_name
required
Any of:
string
vat_treatment
required
VATTreatment

VAT treatment type for API responses.

string
Allowed values: domestic eu_b2b_reverse_charge eu_b2c export
vat_treatment_description
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example 
{
  "vat_treatment": "domestic"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}