Create Invoice

post

https://business.mamopay.com/manage_api/v1/invoices

API to create and send an invoice to a customer via email.

Body Params

amount

number

required

≥ 0

Defaults to 123

The invoice amount to be charged to the customer.

amount_currency

string

enum

Defaults to AED

Currency code for the invoice amount. See examples for more details.

Allowed:

string

required

The customer's email address where the invoice will be sent.

description

string

A description of the invoice. This will appear on the invoice sent to the customer.

customer_type

string

enum

required

Defaults to individual

The type of customer receiving the invoice.

Allowed:

first_name

string

required

The first name of the customer.

last_name

string

required

The last name of the customer.

phone_number

string

The customer's phone number.

business_name

string

The customer's business name. Applicable when customer_type is business.

address

string

The customer's address. Applicable when customer_type is business.

city

string

The customer's city. Applicable when customer_type is business.

country

string

The customer's country. Applicable when customer_type is business.

uae_tax_reference_number

string

The customer's UAE tax reference number (TRN). Applicable when customer_type is business.

vat_enabled

boolean

Defaults to false

Whether VAT should be applied and displayed on the invoice.

additional_heading

string

An optional heading that will appear as additional information on the invoice.

additional_details

string

Optional additional details or notes to include on the invoice.

additional_cc_emails

array of strings

A list of additional email addresses to CC when the invoice is sent.

additional_cc_emails

external_id

string

An external reference ID of your choice to associate with this invoice.

processing_fee_percentage

number | null

≥ 0

A processing fee percentage to be added on top of the invoice amount and charged to the customer.

processing_fee_amount

number | null

≥ 0

A fixed processing fee amount to be added on top of the invoice amount and charged to the customer.

Headers

Authorization

string

Responses

500

Unexpected error

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response

403Unauthorised

422Unprocessable entity