Invoices

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",
    "cancel_reason": "API test cancellation",
    "permalink": "https://web.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.0",
        "quantity": "1.0",
        "unit": "un",
        "tax": {
          "id": 756700,
          "name": "IVA23",
          "value": 23
        },
        "subtotal": 100,
        "tax_amount": 23,
        "total": 123
      }
    ],
    "mb_reference": {
      "entity": "10611",
      "reference": "123 456 789",
      "value": 123.45
    }
  }
}

Changes

Changed in 1 of the 3 revisions of this API.1015

Aug 25, 20265b82d4eb0d9f1015See the full diff
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response's property type changed from object to array for status
  response-property-type-changed
- ▲
  the /// response's property type changed from number to string for status
  response-property-type-changed
- ▲
  the /// response's property type changed from number to string for status
  response-property-type-changed
- ▲
  the / response's property type changed from string to integer null for status
  response-property-type-changed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history