Expenses

PreviousFile NextLocations

Retrieve all expenses

Retrieve expenses for a company

get

/expenses

Query parameters

per_pageinteger

limit of records per page

Example: 10

pageinteger

page number

Example: 2

vendor_idstring

ID of the supplier associated with the expense

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

transacted_fromdate

date of the transaction you want to filter frome

Example: 2022-03-23

transacted_todate

date of the transaction you wish to filter to

Example: 2023-03-23

memostring

This field is used to filter by vendor memo. (LIKE)

Example: test

sort_bystring

This parameter is used to sort the records by a specific field (created_at,transacted_at,recorded_at)

Example: created_at

sort_dirstring

Order type(asc or desc)

Example: asc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://app.greenplaces.com/api/expenses'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": [
    {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "vendor": {
        "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
        "name": "test name",
        "description": "description...",
        "website": "https://www.example.com/",
        "notes": "notes...",
        "services_provided": "example",
        "products_purchased": "example",
        "account_manager_name": "name manager",
        "account_manager_email": "example@gmail.com",
        "currency": "USD",
        "score": "2",
        "updated_at": "2023-06-12T17:30:21.000000Z",
        "created_at": "2023-06-12T17:30:21.000000Z"
      },
      "memo": "This is a memo",
      "amount": "100.00",
      "currency": "USD",
      "ceda_six_industry_id": "1111B0",
      "transacted_at": "2023-06-12",
      "recorded_at": "2023-06-12",
      "updated_at": "2023-06-12T17:30:21.000000Z",
      "created_at": "2023-06-12T17:30:21.000000Z"
    }
  ],
  "meta": {
    "pagination": {
      "current": "1",
      "last_page": "1",
      "per_page": "10",
      "total": "6"
    }
  }
}

Successful operation

Create an expense

Create an expense for a company

post

/expenses

Body

vendor_idany

Vendor ID for the Expense

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

memoany

Memo for the Expense

Example: This is a memo

amountany

Amount for the Expense

Example: 100.00

currencyanyrequired

Currency for the Expense

Example: USD

ceda_six_industryany

CEDA six industry Code or UUID for the Expense

Example: 1111B0

transacted_atanyrequired

Transacted At for the Expense

Example: 1999-01-01

recorded_atanyrequired

Recorded At for the Expense

Example: 1999-01-01

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://app.greenplaces.com/api/expenses' \
  --header 'Content-Type: application/json' \
  --data '{
    "vendor_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "memo": "This is a memo",
    "amount": "100.00",
    "currency": "USD",
    "ceda_six_industry": "1111B0",
    "transacted_at": "1999-01-01",
    "recorded_at": "1999-01-01"
  }'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "vendor": {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "name": "test name",
      "description": "description...",
      "website": "https://www.example.com/",
      "notes": "notes...",
      "services_provided": "example",
      "products_purchased": "example",
      "account_manager_name": "name manager",
      "account_manager_email": "example@gmail.com",
      "currency": "USD",
      "score": "2",
      "updated_at": "2023-06-12T17:30:21.000000Z",
      "created_at": "2023-06-12T17:30:21.000000Z"
    },
    "memo": "This is a memo",
    "amount": "100.00",
    "currency": "USD",
    "ceda_six_industry_id": "1111B0",
    "transacted_at": "2023-06-12",
    "recorded_at": "2023-06-12",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Retrieve an expense

obtain information about a an expense

get

/expenses/{id}

Path parameters

idstringrequired

ID of the the Expense

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://app.greenplaces.com/api/expenses/{id}'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "vendor": {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "name": "test name",
      "description": "description...",
      "website": "https://www.example.com/",
      "notes": "notes...",
      "services_provided": "example",
      "products_purchased": "example",
      "account_manager_name": "name manager",
      "account_manager_email": "example@gmail.com",
      "currency": "USD",
      "score": "2",
      "updated_at": "2023-06-12T17:30:21.000000Z",
      "created_at": "2023-06-12T17:30:21.000000Z"
    },
    "memo": "This is a memo",
    "amount": "100.00",
    "currency": "USD",
    "ceda_six_industry_id": "1111B0",
    "transacted_at": "2023-06-12",
    "recorded_at": "2023-06-12",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Update an expense

Update of an expense

put

/expenses/{id}

Path parameters

idstringrequired

ID of the the Expense

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Body

vendor_idany

Vendor ID for the Expense

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

memoany

Memo for the Expense

Example: This is a memo

amountany

Amount for the Expense

Example: 100.00

currencyanyrequired

Currency for the Expense

Example: USD

ceda_six_industryany

CEDA six industry ID for the Expense

Example: 1111B0

transacted_atanyrequired

Transacted At for the Expense

Example: 1999-01-01

recorded_atanyrequired

Recorded At for the Expense

Example: 1999-01-01

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://app.greenplaces.com/api/expenses/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "vendor_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "memo": "This is a memo",
    "amount": "100.00",
    "currency": "USD",
    "ceda_six_industry": "1111B0",
    "transacted_at": "1999-01-01",
    "recorded_at": "1999-01-01"
  }'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "vendor": {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "name": "test name",
      "description": "description...",
      "website": "https://www.example.com/",
      "notes": "notes...",
      "services_provided": "example",
      "products_purchased": "example",
      "account_manager_name": "name manager",
      "account_manager_email": "example@gmail.com",
      "currency": "USD",
      "score": "2",
      "updated_at": "2023-06-12T17:30:21.000000Z",
      "created_at": "2023-06-12T17:30:21.000000Z"
    },
    "memo": "This is a memo",
    "amount": "100.00",
    "currency": "USD",
    "ceda_six_industry_id": "1111B0",
    "transacted_at": "2023-06-12",
    "recorded_at": "2023-06-12",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Delete an expense

remove an expense

delete

/expenses/{id}

Path parameters

idstringrequired

ID of the the Expense

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://app.greenplaces.com/api/expenses/{id}'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": null,
  "meta": {}
}

Successful operation