Export Disbursements

GET 
/exports/disbursements

Exports a CSV file of disbursements.

Request

Query Parameters

q string

A search term used to query through the disbursement names.

status DisbursementStatus
Possible values: [DRAFT, READY, STARTED, PAUSED, COMPLETED]
Exact match on the status of the disbursement.
Example: DRAFT
created_at_after string
Only return disbursements that are created after this date. Format: YYYY-MM-DD
Example: 2006-01-02
created_at_before string
Only return disbursements that are created before this date. Format: YYYY-MM-DD
Example: 2006-01-02
sort string

Possible values: [name, created_at]

Default value: created_at

Field used to sort disbursements

direction string

Possible values: [asc, desc]

Default value: asc

Direction for sorting disbursements.

Responses

200

CSV file of disbursements

text/csv

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

application/json

Schema

Schema

any

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

*/*

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

application/json

Schema

Schema

any

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

Loading...