v1
latestOpenAPI 3.1.02026-08-0658107212.4 KBInvoices
Cancel Payment
put/receipts/{receipt-id}/change-state.json
Path parameters
receipt-idinteger required
Example:42
Query parameters
api_keystring required
Example:YOUR_API_KEY
Your API Key.
Request body
Example request
{
"receipt": {
"state": "canceled",
"message": "Error"
}
}Response
SUCCESS
Example response
{
"receipt": {
"id": 2137287,
"status": "final",
"type": "Invoice",
"sequence_number": "6/G",
"inverted_sequence_number": "G/6",
"atcud": "ABCD1234-6",
"sequence_id": "12345",
"tax_exemption": "M01",
"date": "04/08/2016",
"due_date": "19/08/2016",
"reference": "ref123",
"observations": "Observations",
"retention": "0",
"permalink": "https://www.app.invoicexpress.com/documents/...",
"saft_hash": "J4ay",
"sum": 24.39,
"before_taxes": 24.39,
"taxes": 5.61,
"total": 30,
"currency": "Euro",
"client": {
"id": 628535,
"name": "John Doe",
"code": "C1",
"country": "Portugal",
"email": "john@example.com"
},
"items": [
{
"name": "Product A",
"description": "Big Product",
"unit_price": 100,
"quantity": 1,
"unit": "un",
"tax": {
"name": "IVA23",
"value": 23
},
"total": 123
}
],
"mb_reference": {
"entity": "10611",
"reference": "123 456 789",
"value": 123.45
}
}
}