Add Note


Description

This method add a notes in the system.

Authentication

Requires HTTP BASIC authentication.The authenticating user must be associated with the creditor.

HTTP Methods

Accepts POST requests.

URI

/api/debtors/{duuid}/notes.json

Path Variables

Name Required/Optional Description Validation
duuid required The UUID of the debtor Debtor UUID should exist in the system.

HTTP Parameters

Name Required/Optional Description Validation
creditor required The UUID of the creditor Creditor UUID should exist in the system.
note optional The description of the note.
type required Note type The type can be ADDRESS_CHANGE, ADDRESS_MAIL_STORE, ALTEREGOFIRM, BANKRUPTCY_FILED, BOND_TRUST, BUSINESS_CLOSE, CANCEL_LEASE, COMPANY_RECEIVERSHIP, CREDIT_HOLD,CREDIT_REVOKED, DORMANT_MC_RESURRECTED, DOUBLE_BROKERING, FRAUD_ACCOUNT,HOLDINGS_LOADS_HOSTAGE, JUDGMENT, LOCATED_AT_SAME_ADDRESS, ON_CASH_TERMS,OWNERSHIP_CHANGE, PAID_OVER_NOTICE, PARENT_OR_AFFILIATE, PHONE_DISCONNECTED, POSSIBLE_AFFILIATE, REFUSAL_OF_NOAS, RETURNED_CHECK_EFT,RETURNED_EQUIPMENT, SKIPPED_NO_FORWARDING, SLOW_PAY, STOP_PAYMENT_ON_CHECK, WRITE_OFF, NO_BUY,OFF_NO_BUY.
writeOffAmount optional The writeOffAmount of the note.
createdDate optional The created date for the note in the format yyyy-MM-dd hh:mm:ss (example: 2015-09-21 19:10:00) WARNING: This should only be used when you need to back date a note..

Curl Example

Request

curl -u apiuser:test -X POST "https://www.factorsnetwork.com/api/debtors/dd1c6e63-7680-4d06-34f6-44d293694bba/notes.json" -d "creditor=710bc35a-d1f2-5678-b576-a15197909044&note=testing&type=SLOW_PAY"
						

Response

{
  "notes" : [ {
    "uuid" : "685da740-5467-3245-fd78-f13c1208fadf",
    "debtorUuid" : "dd1c6e63-7680-4d06-34f6-44d293694bba",
    "creditorUuid" : "710bc35a-d1f2-5678-b576-a15197909044",
    "complaint" : "testing",
    "noteType" : "SLOW_PAY",
    "writeOffAmount" : 0,
    "creationDate" : "2013-12-16 15:02:32"
  } ]
}

Request url for NO_BUY and WRITE_OFF note type

curl -u apiuser:test -X POST https://www.factorsnetwork.com/api/debtors/645d5f2e-4dba-411c-a74c-b4e7ca00c8bf/notes.json -d "creditor=24b3602c-dacc-4022-9ade-ecf99f749519&note=testing&type=WRITE_OFF&writeOffAmount=1234"
						

Response

{
  "notes" : [ {
    "uuid" : "f9a1e3d5-d1f2-48cd-a313-bfd36b5e3656",
    "debtorUuid" : "645d5f2e-4dba-411c-a74c-b4e7ca00c8bf",
    "creditorUuid" : "24b3602c-dacc-4022-9ade-ecf99f749518",
    "complaint" : "testing",
    "noteType" : "WRITE_OFF",
    "writeOffAmount" : 12354,
    "creationDate" : "2013-03-22 16:18:40"
  } ]
}

Note: Responses will not be pretty printed when using the API, but have been formatted here for documentation purposes.