Update Payment
PATCH {{baseUrl}}/accounting/payments/:id?raw=false
Update Payment
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
raw | boolean | Include raw response. Mostly used for debugging purposes |
Request Body
{"total_amount"=>49.99, "transaction_date"=>"2021-05-01T12:00:00.000Z", "currency"=>"USD", "currency_rate"=>0.69, "reference"=>"123456", "payment_method"=>"cash", "payment_method_reference"=>"123456", "payment_method_id"=>"12345", "accounts_receivable_account_type"=>"Account", "accounts_receivable_account_id"=>"123456", "account"=>{"id"=>"123456", "nominal_code"=>"N091", "code"=>"453"}, "customer"=>{"id"=>"12345", "display_name"=>"Windsurf Shop", "name"=>"Windsurf Shop", "email"=>"boring@boring.com"}, "supplier"=>{"display_name"=>"Windsurf Shop", "address"=>{"id"=>"123", "type"=>"primary", "string"=>"25 Spring Street, Blackburn, VIC 3130", "name"=>"HQ US", "line1"=>"Main street", "line2"=>"apt #", "line3"=>"Suite #", "line4"=>"delivery instructions", "street_number"=>"25", "city"=>"San Francisco", "state"=>"CA", "postal_code"=>"94104", "country"=>"US", "latitude"=>"40.759211", "longitude"=>"-73.984638", "county"=>"Santa Clara", "contact_name"=>"Elon Musk", "salutation"=>"Mr", "phone_number"=>"111-111-1111", "fax"=>"122-111-1111", "email"=>"elon@musk.com", "website"=>"https://elonmusk.com", "notes"=>"Address notes or delivery instructions.", "row_version"=>"1-12345"}}, "company_id"=>"12345", "reconciled"=>true, "status"=>"authorised", "type"=>"accounts_receivable", "allocations"=>[{"id"=>"123456", "type"=>"journal_entry", "amount"=>49.99, "allocation_id"=>"123456"}, {"id"=>"123456", "type"=>"over_payment", "amount"=>49.99, "allocation_id"=>"123456"}], "note"=>"Some notes about this transaction", "number"=>"123456", "tracking_categories"=>[{"id"=>"123456", "name"=>"New York"}, {"id"=>"123456", "name"=>"New York"}], "custom_fields"=>[{"id"=>"2389328923893298", "name"=>"employee_level", "description"=>"Employee Level", "value"=>"Uses Salesforce and Marketo"}, {"id"=>"2389328923893298", "name"=>"employee_level", "description"=>"Employee Level", "value"=>"Uses Salesforce and Marketo"}], "row_version"=>"1-12345", "display_id"=>"123456"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-apideck-consumer-id | string | (Required) ID of the consumer which you want to get or push data from | |
x-apideck-app-id | string | (Required) The ID of your Unify application | |
x-apideck-service-id | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"status_code":200,"status":"OK","service":"xero","resource":"payments","operation":"update","data":{"id":"12345"}}