FIfieldpulse
Payments

Update payment by ID

Changed on

Update a payment

put/payments/{id}

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/payments/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Request body

invoice_idinteger

Existing invoice id.

payment_dateinteger

Unix timestamp.

amountstring

A number, sent as a string.

method 'cash' | 'check' | 'card' | 'square' | 'bank_transfer' | 'other' required
payment_method_idinteger nullable

Existing payment method id.

notesstring
square_transaction_idstring

Response

Successful response

errorboolean

false when the request succeeds.

responseobject

The updated record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property