Raise pending invoices now

POST

/invoices/pending/raise

const url = 'https://example.com/invoices/pending/raise';
const options = {
  method: 'POST',
  headers: {
    cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>',
    'Content-Type': 'application/json'
  },
  body: '{"customerIds":["019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/invoices/pending/raise \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "customerIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ] }'

Raises each customer’s next invoice now, for everything up to and including today, instead of waiting for their usual date. Their next invoice starts tomorrow and goes out on the usual date, so nothing is billed twice or missed. A period that is already due is raised first, on its own invoice. Customers with nothing to bill are listed as skipped. To undo, cancel the invoice: cancelling a customer’s latest invoice puts its orders and period back as they were.

Authorizations

sessionCookie
invoices:write
apiKey
invoices:write

Request Body

application/json

object

customerIds

required

Array<string>

>= 1 items <= 200 items

Responses

200

The invoices raised, and the customers skipped with the reason

application/json

object

raised

required

Array<object>

object

customerId

required

UUID v7

string format: uuid

invoiceId

required

UUID v7

string format: uuid

number

required

string

totalPence

required

integer

skipped

required

Array<object>

object

customerId

required

UUID v7

string format: uuid

customerName

required

string | null

reason

required

string

Allowed values: not_found not_scheduled nothing_to_bill

Example

{
  "raised": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "invoiceId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "skipped": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "reason": "not_found"
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}