Create an invoice
Changed onCreate a new invoice for an order.
What happens
- Invoice record is created for the order
- Order status updates to DELIVERED_UNPAID
- Due date calculated from payment term if not provided
Note
Each shipment can have only one AR invoice. Use POST /shipments/{id}/invoice/generate to generate the invoice PDF document.
Request
- Base URL: https://api.mvmnt.io/v1
- URL: https://api.mvmnt.io/v1/invoices
- Auth: HTTP bearer
Request body
Response
Invoice created successfully
Example response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"friendlyId": "INV-00001",
"customer": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CUSTOMER-ACME",
"name": "Acme Manufacturing Corp",
"friendlyId": "A123456",
"status": "ACTIVE",
"phoneNumber": "+1-555-123-4567",
"website": "https://acme-manufacturing.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"currency": "USD",
"paymentTerm": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-PAYTERM-NET30",
"name": "Net 30",
"description": "Payment due 30 days from invoice date",
"days": 30,
"quickPayFee": 5,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}Changes
- breaking
the
response's property type changed fromstringto no type for status - info
added to the
response propertyallOflist for the response status - info
removed the
AWAITING_PAYMENTenum value from theresponse property for the response status - info
removed the
DRAFTenum value from theresponse property for the response status - info
removed the
PAIDenum value from theresponse property for the response status - info
removed the
PARTIALLY_PAIDenum value from theresponse property for the response status - info
removed the
VOIDEDenum value from theresponse property for the response status
- breaking
- breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - info
added
subschema #2to the response bodyallOflist for the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking