POST api/batch/{batchId}/document/{document_id}/payment/{id}

Request Information

URI Parameters

Name	Type	Additional information
batchId	integer	Required
document_id	string	Required
id	string	Required

Body Parameters

DocumentCasePaymentDetailsModel

Name	Type	Additional information
id	string	None.
case_id	string	None.
check_number	string	None.
check_date	string	None.
check_amount	string	None.
batch_reference_id	string	None.
document_reference_id	string	None.
patient_first_name	string	None.
patient_last_name	string	None.
patient_full_name	string	None.
claim_number	string	None.
insurance_company_name	string	None.
accident_date	string	None.
provider_name	string	None.
attorney_lawfirm_name	string	None.
status	string	None.
provider_map_id	integer	None.
insurance_company_map_id	integer	None.
provider_map_name	string	None.
insurance_company_map_name	string	None.
dos_start	string	None.
dos_end	string	None.
transaction_type	string	None.
transaction_amount	string	None.
transaction_status	string	None.
transaction_date	string	None.
reason	string	None.
index_number	string	None.
index_aaa_number	string	None.
batch_number	string	None.
total_claim_amount	string	None.
cheque_count	integer	None.
interest_count	integer	None.
is_case_filed	boolean	None.
add_interest	boolean	None.
interest_amount	string	None.
add_current_status	boolean	None.
current_status	string	None.
document_payment_status	BatchDocumentCaseStatus	None.
next_payment_status	BatchDocumentCaseStatus	None.
secondary_linked_ids	Collection of string	None.
review_start_date	date	None.
review_end_date	date	None.

Request Formats

application/json, text/json

Sample:

{
  "id": "sample string 1",
  "case_id": "sample string 2",
  "check_number": "sample string 3",
  "check_date": "sample string 4",
  "check_amount": "sample string 5",
  "batch_reference_id": "sample string 6",
  "document_reference_id": "sample string 7",
  "patient_first_name": "sample string 8",
  "patient_last_name": "sample string 9",
  "patient_full_name": "sample string 10",
  "claim_number": "sample string 11",
  "insurance_company_name": "sample string 12",
  "accident_date": "sample string 13",
  "provider_name": "sample string 14",
  "attorney_lawfirm_name": "sample string 15",
  "status": "sample string 16",
  "provider_map_id": 1,
  "insurance_company_map_id": 1,
  "provider_map_name": "sample string 17",
  "insurance_company_map_name": "sample string 18",
  "dos_start": "sample string 19",
  "dos_end": "sample string 20",
  "transaction_type": "sample string 21",
  "transaction_amount": "sample string 22",
  "transaction_status": "sample string 23",
  "transaction_date": "sample string 24",
  "reason": "sample string 25",
  "index_number": "sample string 26",
  "index_aaa_number": "sample string 27",
  "batch_number": "sample string 28",
  "total_claim_amount": "sample string 29",
  "cheque_count": 30,
  "interest_count": 31,
  "is_case_filed": true,
  "add_interest": true,
  "interest_amount": "sample string 33",
  "add_current_status": true,
  "current_status": "sample string 35",
  "treatments": [
    {
      "id": "sample string 1",
      "case_reference_id": "sample string 2",
      "claim_amount": "sample string 3",
      "dos_start": "sample string 4",
      "dos_end": "sample string 5",
      "service_location": "sample string 6",
      "service_type": "sample string 7",
      "cpt_detail": [
        {
          "amount": 1.0,
          "paid_amount": 1.0,
          "cpt_code": "sample string 1",
          "unit": "sample string 2",
          "diagnosis_description": "sample string 3",
          "explanation_code": "sample string 4",
          "modifier": "sample string 5",
          "dos_start": "sample string 6",
          "deductible": 1.1
        },
        {
          "amount": 1.0,
          "paid_amount": 1.0,
          "cpt_code": "sample string 1",
          "unit": "sample string 2",
          "diagnosis_description": "sample string 3",
          "explanation_code": "sample string 4",
          "modifier": "sample string 5",
          "dos_start": "sample string 6",
          "deductible": 1.1
        }
      ],
      "denial_reasons": [
        {
          "denial_reason_id": 1,
          "action_type": "sample string 2",
          "denial_reason_date": "2026-08-30T18:44:31.1604771+00:00",
          "ime_date": "2026-08-30T18:44:31.1604771+00:00",
          "note": "sample string 3"
        },
        {
          "denial_reason_id": 1,
          "action_type": "sample string 2",
          "denial_reason_date": "2026-08-30T18:44:31.1604771+00:00",
          "ime_date": "2026-08-30T18:44:31.1604771+00:00",
          "note": "sample string 3"
        }
      ],
      "case_id": "sample string 8",
      "document_category_type": [
        1,
        2
      ],
      "eob_explainations": [
        {
          "explanation_code": "sample string 1",
          "explanation": "sample string 2"
        },
        {
          "explanation_code": "sample string 1",
          "explanation": "sample string 2"
        }
      ],
      "status": "Scheduled",
      "treating_doctor_id": 1,
      "location_id": 1,
      "treating_doctor_name": "sample string 9",
      "bill_sent_date": "sample string 10",
      "paid_amount": 1.0,
      "provider_map_id": 1,
      "provider_map_name": "sample string 11",
      "provider_name": "sample string 12",
      "denial_date": "sample string 13",
      "message": "sample string 14",
      "fee_schedule": "sample string 15",
      "bill_match_status": "New",
      "treatment_id": 1,
      "deductible": 1.1
    },
    {
      "id": "sample string 1",
      "case_reference_id": "sample string 2",
      "claim_amount": "sample string 3",
      "dos_start": "sample string 4",
      "dos_end": "sample string 5",
      "service_location": "sample string 6",
      "service_type": "sample string 7",
      "cpt_detail": [
        {
          "amount": 1.0,
          "paid_amount": 1.0,
          "cpt_code": "sample string 1",
          "unit": "sample string 2",
          "diagnosis_description": "sample string 3",
          "explanation_code": "sample string 4",
          "modifier": "sample string 5",
          "dos_start": "sample string 6",
          "deductible": 1.1
        },
        {
          "amount": 1.0,
          "paid_amount": 1.0,
          "cpt_code": "sample string 1",
          "unit": "sample string 2",
          "diagnosis_description": "sample string 3",
          "explanation_code": "sample string 4",
          "modifier": "sample string 5",
          "dos_start": "sample string 6",
          "deductible": 1.1
        }
      ],
      "denial_reasons": [
        {
          "denial_reason_id": 1,
          "action_type": "sample string 2",
          "denial_reason_date": "2026-08-30T18:44:31.1604771+00:00",
          "ime_date": "2026-08-30T18:44:31.1604771+00:00",
          "note": "sample string 3"
        },
        {
          "denial_reason_id": 1,
          "action_type": "sample string 2",
          "denial_reason_date": "2026-08-30T18:44:31.1604771+00:00",
          "ime_date": "2026-08-30T18:44:31.1604771+00:00",
          "note": "sample string 3"
        }
      ],
      "case_id": "sample string 8",
      "document_category_type": [
        1,
        2
      ],
      "eob_explainations": [
        {
          "explanation_code": "sample string 1",
          "explanation": "sample string 2"
        },
        {
          "explanation_code": "sample string 1",
          "explanation": "sample string 2"
        }
      ],
      "status": "Scheduled",
      "treating_doctor_id": 1,
      "location_id": 1,
      "treating_doctor_name": "sample string 9",
      "bill_sent_date": "sample string 10",
      "paid_amount": 1.0,
      "provider_map_id": 1,
      "provider_map_name": "sample string 11",
      "provider_name": "sample string 12",
      "denial_date": "sample string 13",
      "message": "sample string 14",
      "fee_schedule": "sample string 15",
      "bill_match_status": "New",
      "treatment_id": 1,
      "deductible": 1.1
    }
  ],
  "treatment_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "payment_type": [
    {
      "Type": "sample string 1",
      "Amount": "sample string 2"
    },
    {
      "Type": "sample string 1",
      "Amount": "sample string 2"
    }
  ],
  "document_payment_status": "Pending",
  "next_payment_status": "Pending",
  "document_category_type": [
    {
      "id": 1,
      "name": "sample string 1",
      "friendly_id": "sample string 2",
      "path": "sample string 3",
      "category": "AOB",
      "page_number": [
        1,
        2
      ],
      "document_id": 1,
      "document_reference_id": "sample string 4",
      "document_name": "sample string 5",
      "document_path": "sample string 6",
      "node_id": 1,
      "node_name": "sample string 7",
      "node_parent_id": 1,
      "status": "Pending",
      "batch_type": "sample string 8"
    },
    {
      "id": 1,
      "name": "sample string 1",
      "friendly_id": "sample string 2",
      "path": "sample string 3",
      "category": "AOB",
      "page_number": [
        1,
        2
      ],
      "document_id": 1,
      "document_reference_id": "sample string 4",
      "document_name": "sample string 5",
      "document_path": "sample string 6",
      "node_id": 1,
      "node_name": "sample string 7",
      "node_parent_id": 1,
      "status": "Pending",
      "batch_type": "sample string 8"
    }
  ],
  "secondary_linked_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "review_start_date": "2026-08-30T18:44:31.1604771+00:00",
  "review_end_date": "2026-08-30T18:44:31.1604771+00:00"
}

text/html

Sample:

{"id":"sample string 1","case_id":"sample string 2","check_number":"sample string 3","check_date":"sample string 4","check_amount":"sample string 5","batch_reference_id":"sample string 6","document_reference_id":"sample string 7","patient_first_name":"sample string 8","patient_last_name":"sample string 9","patient_full_name":"sample string 10","claim_number":"sample string 11","insurance_company_name":"sample string 12","accident_date":"sample string 13","provider_name":"sample string 14","attorney_lawfirm_name":"sample string 15","status":"sample string 16","provider_map_id":1,"insurance_company_map_id":1,"provider_map_name":"sample string 17","insurance_company_map_name":"sample string 18","dos_start":"sample string 19","dos_end":"sample string 20","transaction_type":"sample string 21","transaction_amount":"sample string 22","transaction_status":"sample string 23","transaction_date":"sample string 24","reason":"sample string 25","index_number":"sample string 26","index_aaa_number":"sample string 27","batch_number":"sample string 28","total_claim_amount":"sample string 29","cheque_count":30,"interest_count":31,"is_case_filed":true,"add_interest":true,"interest_amount":"sample string 33","add_current_status":true,"current_status":"sample string 35","treatments":[{"id":"sample string 1","case_reference_id":"sample string 2","claim_amount":"sample string 3","dos_start":"sample string 4","dos_end":"sample string 5","service_location":"sample string 6","service_type":"sample string 7","cpt_detail":[{"amount":1.0,"paid_amount":1.0,"cpt_code":"sample string 1","unit":"sample string 2","diagnosis_description":"sample string 3","explanation_code":"sample string 4","modifier":"sample string 5","dos_start":"sample string 6","deductible":1.1},{"amount":1.0,"paid_amount":1.0,"cpt_code":"sample string 1","unit":"sample string 2","diagnosis_description":"sample string 3","explanation_code":"sample string 4","modifier":"sample string 5","dos_start":"sample string 6","deductible":1.1}],"denial_reasons":[{"denial_reason_id":1,"action_type":"sample string 2","denial_reason_date":"2026-08-30T18:44:31.1604771+00:00","ime_date":"2026-08-30T18:44:31.1604771+00:00","note":"sample string 3"},{"denial_reason_id":1,"action_type":"sample string 2","denial_reason_date":"2026-08-30T18:44:31.1604771+00:00","ime_date":"2026-08-30T18:44:31.1604771+00:00","note":"sample string 3"}],"case_id":"sample string 8","document_category_type":[1,2],"eob_explainations":[{"explanation_code":"sample string 1","explanation":"sample string 2"},{"explanation_code":"sample string 1","explanation":"sample string 2"}],"status":"Scheduled","treating_doctor_id":1,"location_id":1,"treating_doctor_name":"sample string 9","bill_sent_date":"sample string 10","paid_amount":1.0,"provider_map_id":1,"provider_map_name":"sample string 11","provider_name":"sample string 12","denial_date":"sample string 13","message":"sample string 14","fee_schedule":"sample string 15","bill_match_status":"New","treatment_id":1,"deductible":1.1},{"id":"sample string 1","case_reference_id":"sample string 2","claim_amount":"sample string 3","dos_start":"sample string 4","dos_end":"sample string 5","service_location":"sample string 6","service_type":"sample string 7","cpt_detail":[{"amount":1.0,"paid_amount":1.0,"cpt_code":"sample string 1","unit":"sample string 2","diagnosis_description":"sample string 3","explanation_code":"sample string 4","modifier":"sample string 5","dos_start":"sample string 6","deductible":1.1},{"amount":1.0,"paid_amount":1.0,"cpt_code":"sample string 1","unit":"sample string 2","diagnosis_description":"sample string 3","explanation_code":"sample string 4","modifier":"sample string 5","dos_start":"sample string 6","deductible":1.1}],"denial_reasons":[{"denial_reason_id":1,"action_type":"sample string 2","denial_reason_date":"2026-08-30T18:44:31.1604771+00:00","ime_date":"2026-08-30T18:44:31.1604771+00:00","note":"sample string 3"},{"denial_reason_id":1,"action_type":"sample string 2","denial_reason_date":"2026-08-30T18:44:31.1604771+00:00","ime_date":"2026-08-30T18:44:31.1604771+00:00","note":"sample string 3"}],"case_id":"sample string 8","document_category_type":[1,2],"eob_explainations":[{"explanation_code":"sample string 1","explanation":"sample string 2"},{"explanation_code":"sample string 1","explanation":"sample string 2"}],"status":"Scheduled","treating_doctor_id":1,"location_id":1,"treating_doctor_name":"sample string 9","bill_sent_date":"sample string 10","paid_amount":1.0,"provider_map_id":1,"provider_map_name":"sample string 11","provider_name":"sample string 12","denial_date":"sample string 13","message":"sample string 14","fee_schedule":"sample string 15","bill_match_status":"New","treatment_id":1,"deductible":1.1}],"treatment_ids":["sample string 1","sample string 2"],"payment_type":[{"Type":"sample string 1","Amount":"sample string 2"},{"Type":"sample string 1","Amount":"sample string 2"}],"document_payment_status":"Pending","next_payment_status":"Pending","document_category_type":[{"id":1,"name":"sample string 1","friendly_id":"sample string 2","path":"sample string 3","category":"AOB","page_number":[1,2],"document_id":1,"document_reference_id":"sample string 4","document_name":"sample string 5","document_path":"sample string 6","node_id":1,"node_name":"sample string 7","node_parent_id":1,"status":"Pending","batch_type":"sample string 8"},{"id":1,"name":"sample string 1","friendly_id":"sample string 2","path":"sample string 3","category":"AOB","page_number":[1,2],"document_id":1,"document_reference_id":"sample string 4","document_name":"sample string 5","document_path":"sample string 6","node_id":1,"node_name":"sample string 7","node_parent_id":1,"status":"Pending","batch_type":"sample string 8"}],"secondary_linked_ids":["sample string 1","sample string 2"],"review_start_date":"2026-08-30T18:44:31.1604771+00:00","review_end_date":"2026-08-30T18:44:31.1604771+00:00"}

application/xml, text/xml

Sample:

<DocumentCasePaymentDetailsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models.AI">
  <accident_date>sample string 13</accident_date>
  <add_current_status>true</add_current_status>
  <add_interest>true</add_interest>
  <attorney_lawfirm_name>sample string 15</attorney_lawfirm_name>
  <batch_number>sample string 28</batch_number>
  <batch_reference_id>sample string 6</batch_reference_id>
  <case_id>sample string 2</case_id>
  <check_amount>sample string 5</check_amount>
  <check_date>sample string 4</check_date>
  <check_number>sample string 3</check_number>
  <cheque_count>30</cheque_count>
  <claim_number>sample string 11</claim_number>
  <current_status>sample string 35</current_status>
  <document_payment_status>Pending</document_payment_status>
  <document_reference_id>sample string 7</document_reference_id>
  <dos_end>sample string 20</dos_end>
  <dos_start>sample string 19</dos_start>
  <id>sample string 1</id>
  <index_aaa_number>sample string 27</index_aaa_number>
  <index_number>sample string 26</index_number>
  <insurance_company_map_id>1</insurance_company_map_id>
  <insurance_company_map_name>sample string 18</insurance_company_map_name>
  <insurance_company_name>sample string 12</insurance_company_name>
  <interest_amount>sample string 33</interest_amount>
  <interest_count>31</interest_count>
  <is_case_filed>true</is_case_filed>
  <next_payment_status>Pending</next_payment_status>
  <patient_first_name>sample string 8</patient_first_name>
  <patient_full_name>sample string 10</patient_full_name>
  <patient_last_name>sample string 9</patient_last_name>
  <provider_map_id>1</provider_map_id>
  <provider_map_name>sample string 17</provider_map_name>
  <provider_name>sample string 14</provider_name>
  <reason>sample string 25</reason>
  <review_end_date>2026-08-30T18:44:31.1604771+00:00</review_end_date>
  <review_start_date>2026-08-30T18:44:31.1604771+00:00</review_start_date>
  <secondary_linked_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </secondary_linked_ids>
  <status>sample string 16</status>
  <total_claim_amount>sample string 29</total_claim_amount>
  <transaction_amount>sample string 22</transaction_amount>
  <transaction_date>sample string 24</transaction_date>
  <transaction_status>sample string 23</transaction_status>
  <transaction_type>sample string 21</transaction_type>
</DocumentCasePaymentDetailsModel>

multipart/form-data

Sample:

<DocumentCasePaymentDetailsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models.AI"><accident_date>sample string 13</accident_date><add_current_status>true</add_current_status><add_interest>true</add_interest><attorney_lawfirm_name>sample string 15</attorney_lawfirm_name><batch_number>sample string 28</batch_number><batch_reference_id>sample string 6</batch_reference_id><case_id>sample string 2</case_id><check_amount>sample string 5</check_amount><check_date>sample string 4</check_date><check_number>sample string 3</check_number><cheque_count>30</cheque_count><claim_number>sample string 11</claim_number><current_status>sample string 35</current_status><document_payment_status>Pending</document_payment_status><document_reference_id>sample string 7</document_reference_id><dos_end>sample string 20</dos_end><dos_start>sample string 19</dos_start><id>sample string 1</id><index_aaa_number>sample string 27</index_aaa_number><index_number>sample string 26</index_number><insurance_company_map_id>1</insurance_company_map_id><insurance_company_map_name>sample string 18</insurance_company_map_name><insurance_company_name>sample string 12</insurance_company_name><interest_amount>sample string 33</interest_amount><interest_count>31</interest_count><is_case_filed>true</is_case_filed><next_payment_status>Pending</next_payment_status><patient_first_name>sample string 8</patient_first_name><patient_full_name>sample string 10</patient_full_name><patient_last_name>sample string 9</patient_last_name><provider_map_id>1</provider_map_id><provider_map_name>sample string 17</provider_map_name><provider_name>sample string 14</provider_name><reason>sample string 25</reason><review_end_date>2026-08-30T18:44:31.1604771+00:00</review_end_date><review_start_date>2026-08-30T18:44:31.1604771+00:00</review_start_date><secondary_linked_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></secondary_linked_ids><status>sample string 16</status><total_claim_amount>sample string 29</total_claim_amount><transaction_amount>sample string 22</transaction_amount><transaction_date>sample string 24</transaction_date><transaction_status>sample string 23</transaction_status><transaction_type>sample string 21</transaction_type></DocumentCasePaymentDetailsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.