FDX REST API

/tax-forms/{taxFormId} PUT

AttributeValue
SummaryUpdate tax form
DescriptionUpdate tax document. Allows you to upload and replace binaries or json document
Operation IdupdateTaxForm

Request Parameters

Parameter Required? Location Type Description
taxFormId required path integer form ID

Request Body

Media Type Content Description
application/jsonArray of TaxDataThe full data contents of the form including the indexing metadata values
application/pdfstringThe form image to upload as pdf
image/gifstringThe form image to upload as gif
image/jpegstringThe form image to upload as jpeg
image/tiffstringThe form image to upload as tiff
image/pngstringThe form image to upload as png

Response

Response Code Response Type Description
200Ok
206application/json of array of TaxDataPartial Content success updating customer Tax Data forms, some errors are being returned
415application/json of ErrorServer does not support the content type uploaded

Example Request

PUT /fdx/v4/tax-forms/283300001 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJjbGkiOiJ0YXhjbGkiLCJ1c2VyIjoiODEyMzQ1Njc4NSIsInBhc3MiOiIyODMzMDAwMDEiLCJpYXQiOjE2MTI5MTIwMTIsImV4cCI6MTYxMjkxNTYxMn0.2RGGNxp6YxVX_TFntgKAoakfPtSdgoRj1VSxpBa5RXo
Content-Type: application/json
User-Agent: Jersey/2.29 (HttpUrlConnection 1.8.0_252)
Host: api.taxdocserver.com
Connection: keep-alive
Content-Length: 1151

[{"taxW2":{"taxYear":2020,"corrected":true,"employeeTin":"888-88-8888","employerTin":"99-1234567","employerNameAddress":{"line1":"444 W Central St","city":"Laramie","state":"WY","postalCode":"82072","name1":"Employer Name"},"controlNumber":"Control Number","employeeName":{"first":"John","middle":"Q","last":"Employee","suffix":"Jr"},"employeeAddress":{"line1":"777 E Fir St","city":"Park City","state":"UT","postalCode":"84060"},"wages":100000.0,"federalTaxWithheld":20000.0,"socialSecurityWages":30000.0,"socialSecurityTaxWithheld":4000.0,"medicareWages":50000.0,"medicareTaxWithheld":600.0,"socialSecurityTips":70.0,"allocatedTips":80.0,"dependentCareBenefit":1000.0,"nonQualifiedPlan":1100.0,"codes":[{"code":"A","amount":100.0},{"code":"B","amount":200.0}],"statutory":true,"retirementPlan":true,"thirdPartySickPay":true,"other":[{"description":"Other Desc","amount":100.0},{"description":"Another Desc","amount":200.0}],"stateTaxWithholding":[{"stateTaxWithheld":1700.0,"state":"UT","stateTaxId":"State Tax Id","stateIncome":16000.0}],"localTaxWithholding":[{"localTaxWithheld":190.0,"localityName":"Local","state":"UT","localIncome":1800.0}]}}]

Example Response

HTTP/1.1 200 OK
Content-Type: application/json
X-Cloud-Trace-Context: 4ddef52efd2501ce8b75e2350bd7a4d0;o=1
Date: Tue, 09 Feb 2021 23:06:56 GMT
Server: Google Frontend
Content-Length: 1684
Connection: keep-alive

[ {
  "taxW2" : {
    "taxYear" : 2020,
    "corrected" : true,
    "taxFormId" : "283300001",
    "employeeTin" : "888-88-8888",
    "employerTin" : "99-1234567",
    "employerNameAddress" : {
      "line1" : "444 W Central St",
      "city" : "Laramie",
      "state" : "WY",
      "postalCode" : "82072",
      "name1" : "Employer Name"
    },
    "controlNumber" : "Control Number",
    "employeeName" : {
      "first" : "John",
      "middle" : "Q",
      "last" : "Employee",
      "suffix" : "Jr"
    },
    "employeeAddress" : {
      "line1" : "777 E Fir St",
      "city" : "Park City",
      "state" : "UT",
      "postalCode" : "84060"
    },
    "wages" : 100000.0,
    "federalTaxWithheld" : 20000.0,
    "socialSecurityWages" : 30000.0,
    "socialSecurityTaxWithheld" : 4000.0,
    "medicareWages" : 50000.0,
    "medicareTaxWithheld" : 600.0,
    "socialSecurityTips" : 70.0,
    "allocatedTips" : 80.0,
    "dependentCareBenefit" : 1000.0,
    "nonQualifiedPlan" : 1100.0,
    "codes" : [ {
      "code" : "A",
      "amount" : 100.0
    }, {
      "code" : "B",
      "amount" : 200.0
    } ],
    "statutory" : true,
    "retirementPlan" : true,
    "thirdPartySickPay" : true,
    "other" : [ {
      "description" : "Other Desc",
      "amount" : 100.0
    }, {
      "description" : "Another Desc",
      "amount" : 200.0
    } ],
    "stateTaxWithholding" : [ {
      "stateTaxWithheld" : 1700.0,
      "state" : "UT",
      "stateTaxId" : "State Tax Id",
      "stateIncome" : 16000.0
    } ],
    "localTaxWithholding" : [ {
      "localTaxWithheld" : 190.0,
      "localityName" : "Local",
      "state" : "UT",
      "localIncome" : 1800.0
    } ]
  }
} ]

© Copyright 2020. All Rights Reserved.