Query Payments

Query payments for a team, optionally filtered by recipient and date range.

GET /v2/payments

Try it

Query Payments

cURL

curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/payments \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "data": {
    "items": [
      {
        "recipient": {
          "nanoid": "<string>",
          "riseid": "<string>",
          "avatar": "<string>",
          "first_name": "<string>",
          "middle_name": "<string>",
          "last_name": "<string>",
          "company_name": "<string>",
          "email": "<string>",
          "address": {
            "country": "<string>",
            "state": "<string>",
            "city": "<string>",
            "line_1": "<string>",
            "zip_code": "<string>",
            "line_2": "<string>"
          }
        },
        "payer": {
          "nanoid": "<string>",
          "riseid": "<string>",
          "avatar": "<string>",
          "name": "<string>"
        },
        "invoice": {
          "currency": "<string>",
          "documents_ids": [
            "<string>"
          ],
          "group_nanoid": "<string>",
          "group_onchain_id": "<string>",
          "hourly_rate_usd_cents": 123,
          "nanoid": "<string>",
          "payer_nanoid": "<string>",
          "recipient_nanoid": "<string>",
          "rise_sow": true,
          "time_entries": [
            {
              "date": "<string>",
              "hours": 123,
              "minutes": 123,
              "notes": "<string>"
            }
          ],
          "type": "batch",
          "amount_cents": 0,
          "created_at": "2023-11-07T05:31:56Z",
          "external_sow_url": "<string>",
          "flat_type": "product",
          "invoice_description": "<string>",
          "invoice_number": "",
          "invoice_status": "draft",
          "pay_intent_time": 0,
          "payroll_program": "riseworks_eor_us",
          "recurrence": "annually",
          "role_description": "<string>",
          "sow_document_nanoid": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "payment": {
          "creation_transaction": "<string>",
          "group_onchain_id": "<string>",
          "invoice_nanoid": "<string>",
          "nanoid": "<string>",
          "onchain_id": "<string>",
          "payment_group_nanoid": "<string>",
          "process_transaction": "<string>",
          "state": "Undefined",
          "pay_at_time": 123,
          "token_amount": "<string>",
          "amount_cents": 123,
          "currency_symbol": "<string>",
          "token_decimals": 123,
          "valid_minutes": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

team_nanoid · string · required

TeamNanoid

Required string length: 15

state · enum<string> · required

Available options: all, intent, scheduled, complete

start_date · required

end_date · required

query_type · enum<string> · required

Available options: payable, receivable

recipient · string

UserNanoid

Required string length: 15

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object · required

Show child attributes

data. items · object[] · required

Show child attributes

data.items. recipient · object · required

Show child attributes

data.items.recipient. nanoid · required

UserNanoid

Required string length: 15

data.items.recipient. riseid · string · required

Required string length: 42

data.items.recipient. avatar · string · required

data.items.recipient. first_name · string | null · required

data.items.recipient. middle_name · string | null · required

data.items.recipient. last_name · string | null · required

data.items.recipient. company_name · string | null · required

data.items.recipient. email · string | null · required

data.items.recipient. address · object · required

Show child attributes

data.items.recipient.address. country · string · required

data.items.recipient.address. state · string · required

data.items.recipient.address. city · string · required

data.items.recipient.address. line_1 · string · required

data.items.recipient.address. zip_code · string · required

data.items.recipient.address. line_2 · string | null

data.items. payer · object · required

Show child attributes

data.items.payer. nanoid · string · required

TeamNanoid

Required string length: 15

data.items.payer. riseid · string · required

Required string length: 42

data.items.payer. avatar · string · required

data.items.payer. name · string · required

data.items. invoice · object · required

Show child attributes

data.items.invoice. currency · string · required

Minimum string length: 1

data.items.invoice. documents_ids · string[] · required

data.items.invoice. group_nanoid · string · required

PaymentGroupNanoid

Required string length: 15

data.items.invoice. group_onchain_id · string · required

Minimum string length: 1

data.items.invoice. hourly_rate_usd_cents · number · required

data.items.invoice. nanoid · string · required

InvoiceNanoid

Required string length: 15

data.items.invoice. payer_nanoid · string · required

TeamNanoid

Required string length: 15

data.items.invoice. recipient_nanoid · required

UserNanoid

Required string length: 15

data.items.invoice. rise_sow · boolean · required

data.items.invoice. time_entries · object[] · required

Show child attributes

data.items.invoice.time_entries. date · string · required

data.items.invoice.time_entries. hours · integer · required

data.items.invoice.time_entries. minutes · integer · required

data.items.invoice.time_entries. notes · string · required

data.items.invoice. type · enum<string> · required

Available options: batch, flat, milestone, paynow, payonce, payroll_cash_requirement, recurring, time_entry

data.items.invoice. amount_cents · number · default: 0

data.items.invoice. created_at

data.items.invoice. external_sow_url · string | null

data.items.invoice. flat_type · enum<string> | null

Available options: product, reimbursement, service

data.items.invoice. invoice_description · string | null

data.items.invoice. invoice_number · string | null · default: ""

data.items.invoice. invoice_status · enum<string> · default: draft

Available options: canceled, closed, draft, open, open_canceled

data.items.invoice. pay_intent_time · number · default: 0

data.items.invoice. payroll_program · enum<string> | null

Available options: riseworks_eor_us, riseworks_inc, riseworks_pps_us

data.items.invoice. recurrence · enum<string> | null

Available options: annually, bi_monthly, bi_weekly, daily, four_weeks, monthly, quartely, six_months, weekly

data.items.invoice. role_description · string | null

data.items.invoice. sow_document_nanoid · string | null

data.items.invoice. updated_at

data.items. payment · object · required

Show child attributes

data.items.payment. creation_transaction · string | null · required

Required string length: 15

data.items.payment. group_onchain_id · string · required

Minimum string length: 1

data.items.payment. invoice_nanoid · string · required

InvoiceNanoid

Required string length: 15

data.items.payment. nanoid · string · required

PaymentNanoid

Required string length: 15

data.items.payment. onchain_id · string · required

Minimum string length: 1

data.items.payment. payment_group_nanoid · string · required

PaymentGroupNanoid

Required string length: 15

data.items.payment. process_transaction · string | null · required

Required string length: 15

data.items.payment. state · enum<string> · required

Available options: Undefined, Intent, Scheduled, Complete, Removed

data.items.payment. pay_at_time · integer · required

data.items.payment. token_amount · string · required

data.items.payment. amount_cents · integer · required

data.items.payment. currency_symbol · string · required

data.items.payment. token_decimals · integer · required

data.items.payment. valid_minutes · integer · required

data.items.payment. created_at

data.items.payment. updated_at