API documentation

Debts

Overview

The Debt object allows to record that you own to contacts, or what your contacts own you.

A debt has to be linked to a contact, always.

If the user owns money to the contact, the in_debt will be yes. If the contact owns money to the user, in_debt will be no.

List all your debts

GET /debts/

Parameters

Name Type Description
limit integer Indicates the page size.
page integer Indicates the page to return.

Response

{
  "data": [
    {
      "id": 428,
      "object": "debt",
      "in_debt": "yes",
      "status": "inprogress",
      "amount": 100,
      "amount_with_currency": "$100",
      "reason": "",
      "account": {
        "id": 1
      },
      "contact": {
        "id": 8,
        "object": "contact",
        "first_name": "Jim",
        "last_name": "Halpert",
        "gender": "male",
        "is_partial": false,
        "information": {
          "dates": [
            {
              "name": "birthdate",
              "is_birthdate_approximate": "exact",
              "birthdate": "1978-10-01T16:20:55Z"
            }
          ]
        },
        "account": {
          "id": 1
        }
      },
      "created_at": "2017-06-14T17:43:13Z",
      "updated_at": "2017-06-14T17:43:20Z"
    },
    {
      "id": 831,
      "object": "debt",
      "in_debt": "no",
      "status": "inprogress",
      "amount": 123,
      "amount_with_currency": "$123",
      "reason": "For the bar last time",
      "account": {
        "id": 1
      },
      "contact": {
        "id": 1,
        "object": "contact",
        "first_name": "Henri",
        "last_name": "Troyat",
        "gender": "female",
        "is_partial": false,
        "information": {
          "dates": [
            {
              "name": "birthdate",
              "is_birthdate_approximate": "exact",
              "birthdate": "1983-10-23T00:00:00Z"
            }
          ]
        },
        "account": {
          "id": 1
        }
      },
      "created_at": "2017-10-21T15:59:14Z",
      "updated_at": "2017-10-21T15:59:14Z"
    },
    {
      "id": 832,
      "object": "debt",
      "in_debt": "yes",
      "status": "inprogress",
      "amount": 431,
      "amount_with_currency": "$431",
      "reason": "For the coffee last time.",
      "account": {
        "id": 1
      },
      "contact": {
        "id": 1,
        "object": "contact",
        "first_name": "Henri",
        "last_name": "Troyat",
        "gender": "female",
        "is_partial": false,
        "information": {
          "dates": [
            {
              "name": "birthdate",
              "is_birthdate_approximate": "exact",
              "birthdate": "1983-10-23T00:00:00Z"
            }
          ]
        },
        "account": {
          "id": 1
        }
      },
      "created_at": "2017-10-21T16:04:08Z",
      "updated_at": "2017-10-21T16:04:08Z"
    }
  ],
  "links": {
    "first": "https:\/\/app.monicahq.com\/api\/debts?page=1",
    "last": "https:\/\/app.monicahq.com\/api\/debts?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https:\/\/app.monicahq.com\/api\/debts",
    "per_page": 10,
    "to": 3,
    "total": 3
  }
}

Get a specific debt

GET /debts/:id

{
  "data": {
    "id": 832,
    "object": "debt",
    "in_debt": "yes",
    "status": "inprogress",
    "amount": 431,
    "amount_with_currency": "$431",
    "reason": "For the coffee last time.",
    "account": {
      "id": 1
    },
    "contact": {
      "id": 1,
      "object": "contact",
      "first_name": "Henri",
      "last_name": "Troyat",
      "gender": "female",
      "is_partial": false,
      "information": {
        "dates": [
          {
            "name": "birthdate",
            "is_birthdate_approximate": "exact",
            "birthdate": "1983-10-23T00:00:00Z"
          }
        ]
      },
      "account": {
        "id": 1
      }
    },
    "created_at": "2017-10-21T16:04:08Z",
    "updated_at": "2017-10-21T16:04:08Z"
  }
}

Create a debt

POST /debts/

Input

If a field is not required, you can send the null value as the content of the field.

Name Type Description
contact_id integer Required. The ID of the contact that the debt is associated with.
in_debt string Required. Value: yes if the user owns money to the contact. no if the contact owns money to the user.
status string Required. State of the debt. Values: inprogress or complete.
amount integer Required. The amount of money owned.
reason string The reason the debt exists. Max 10000000 characters.

Example

{
  "in_debt":"yes",
  "status":"inprogress",
  "amount":325,
  "reason":"He bought half the pizza",
  "contact_id": 1
}

Response

The API call returns a debt object if the call succeeds.

{
  "data": {
    "id": 835,
    "object": "debt",
    "in_debt": "yes",
    "status": "inprogress",
    "amount": 325,
    "amount_with_currency": "$325",
    "reason": "He bought half the pizza",
    "account": {
      "id": 1
    },
    "contact": {
      "id": 1,
      "object": "contact",
      "first_name": "Henri",
      "last_name": "Troyat",
      "gender": "female",
      "is_partial": false,
      "information": {
        "dates": [
          {
            "name": "birthdate",
            "is_birthdate_approximate": "exact",
            "birthdate": "1983-10-23T00:00:00Z"
          }
        ]
      },
      "account": {
        "id": 1
      }
    },
    "created_at": "2017-10-21T16:16:26Z",
    "updated_at": "2017-10-21T16:16:26Z"
  }
}

Update a debt

PUT /debts/:id

Input

Name Type Description
contact_id integer Required. The ID of the contact that the debt is associated with.
in_debt string Required. Value: yes if the user owns money to the contact. no if the contact owns money to the user.
status string Required. State of the debt. Values: inprogress or complete.
amount integer Required. The amount of money owned.
reason string The reason the debt exists. Max 10000000 characters.

Example

{
  "in_debt":"yes",
  "status":"inprogress",
  "amount":23,
  "reason":"He bought half the pizza",
  "contact_id": 1
}

Response

{
  "data": {
    "id": 835,
    "object": "debt",
    "in_debt": "yes",
    "status": "inprogress",
    "amount": 23,
    "amount_with_currency": "$23",
    "reason": "He bought half the pizza",
    "account": {
      "id": 1
    },
    "contact": {
      "id": 1,
      "object": "contact",
      "first_name": "Henri",
      "last_name": "Troyat",
      "gender": "female",
      "is_partial": false,
      "information": {
        "dates": [
          {
            "name": "birthdate",
            "is_birthdate_approximate": "exact",
            "birthdate": "1983-10-23T00:00:00Z"
          }
        ]
      },
      "account": {
        "id": 1
      }
    },
    "created_at": "2017-10-21T16:16:26Z",
    "updated_at": "2017-10-21T16:19:54Z"
  }
}

Delete a debt

DELETE /debts/:id

Response

The response sends back the id that was just deleted.

{
  "deleted": true,
  "id": 31
}

Company

Resources

© 2018

Proudly Canadian