Create and optionally send an invoice

post https://api-sandbox.branddrive.co/api/v1/api/v1/invoice

API endpoint to create an invoice and send it to a customer's email (optional).

Body Params

branchId

int32

required

Your business's branch id

send

boolean

required

Defaults to false

To determine if the created invoice should be sent to the customer's email

issuedAt

date

The date the invoice was issued

dueAt

date

The date the invoice is due for

customerId

int32

The id of customer associated to the invoice

SONumber

int32

The Sales Order Number of the invoice

currency

string

The currency of the invoice

note

string

Any note to be contained in the invoice

invoiceName

string

The name of the invoice

procurements

array

An array of procurements that are associated to the invoice

procurements

paymentMethods

array of strings

All the payment methods accepted in the invoice

paymentMethods

discount

int32

Discount added to the invoice

totalAmountDue

int32

The total amount due for the invoice

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.branddrive.co/api/v1/api/v1/invoice \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"send":false}'

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

application/json

201201

400400