Create a payment
Changed onRecord a customer payment applied to invoices.
What happens
- Payment record is created
- Specified amounts are applied to invoices
- Invoice/order status updated to PAID when fully paid
- Overpayment creates a credit memo automatically
Validations
- Payment date must be >= invoice date for all applied invoices
- Application amounts must not exceed invoice open balances
- Customer must match invoice customer
Request
- Base URL: https://api.mvmnt.io/v1
- URL: https://api.mvmnt.io/v1/payments
- Auth: HTTP bearer
Request body
Response
Payment created successfully
Example response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "PMT-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"
}Changes
- 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 - 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 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
- warning
added the new
BLOCKEDenum value to the/response property for the response status - warning
added the new
CLOSEDenum value to the/response property for the response status - warning
added the new
CONTACTEDenum value to the/response property for the response status - warning
added the new
NEWenum value to the/response property for the response status - warning
added the new
NURTURINGenum value to the/response property for the response status - warning
added the new
PENDINGenum value to the/response property for the response status - warning
added the new
QUALIFIEDenum value to the/response property for the response status - warning
added the new
QUOTEDenum value to the/response property for the response status - info
removed the
CHURNEDenum value from the/response property for the response status - info
removed the
PROSPECTenum value from the/response property for the response status
- warning