Amend a previously accepted filing

Beta — contact Cadana to enable access for your business.

Creates an amendment filing linked to the original. The original filing’s status remains accepted and gains an amendedBy reference to the new filing. The new amendment filing starts in pending status.

POST /v1/statutory/filings/{filing_id}/amend

Amend a previously accepted filing

cURL

curl --request POST \
  --url https://api.cadanapay.com/v1/statutory/filings/{filing_id}/amend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "correctedAmounts": {
    "currency": "MXN",
    "total": 82345
  }
}
'

import requests

url = "https://api.cadanapay.com/v1/statutory/filings/{filing_id}/amend"

payload = {
    "reason": "<string>",
    "correctedAmounts": {
        "currency": "MXN",
        "total": 82345
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', correctedAmounts: {currency: 'MXN', total: 82345}})
};

fetch('https://api.cadanapay.com/v1/statutory/filings/{filing_id}/amend', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadanapay.com/v1/statutory/filings/{filing_id}/amend",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'correctedAmounts' => [
        'currency' => 'MXN',
        'total' => 82345
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cadanapay.com/v1/statutory/filings/{filing_id}/amend"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"correctedAmounts\": {\n    \"currency\": \"MXN\",\n    \"total\": 82345\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cadanapay.com/v1/statutory/filings/{filing_id}/amend")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"correctedAmounts\": {\n    \"currency\": \"MXN\",\n    \"total\": 82345\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/statutory/filings/{filing_id}/amend")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"correctedAmounts\": {\n    \"currency\": \"MXN\",\n    \"total\": 82345\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "fil_01HQ3K4N7XYZABC"
}

{
  "error": {
    "code": "invalid_request",
    "message": "countryCode is required",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey · string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

filing_id · string · required

Filing identifier

Body

application/json

reason · string · required

Reason for the amendment

correctedAmounts · object

Derived totals for the filing. Read-only on responses — Cadana computes these values from the breakdown lines. You do not pass amounts when creating a filing; provide the breakdown array and the total falls out automatically.

Show child attributes

Response

201

application/json

Amendment filing created

Response containing the ID of a newly created resource.

id · string

Example:

"fil_01HQ3K4N7XYZABC"