Create Batch
POST/api/v1/batches
Create a new batch of invoices for bulk processing.
Batch Types:
send: Validate and send all invoicesvalidate: Only validate (dry run)schedule: Validate now, send at scheduled time
Scheduling: a schedule batch needs scheduled_at (ISO 8601; UTC when it
carries no offset), not in the past, and is sent once, within a minute or so of
that time. One first picked up more than 24 hours after its scheduled_at is
not sent: it ends failed with an error_message starting SCHEDULE_EXPIRED.
scheduled_at on a send or validate batch, an unknown batch_type, or a
schedule batch without a future scheduled_at is refused with 422.
A schedule batch is sent by the platform at its time, so creating one needs
the invoices:send permission as well (as /process does); send and
validate batches need only invoices:create.
Limits: Maximum 1000 invoices per batch.
Request
Responses
- 201
- 422
Successful Response
Validation Error