company_payments resource

GET https://api.multinexo.comcompanies/{company_id}/company_payments

Attributes

amount: create, read, update numeric
plan_id: create, read, update
description: create, read, update
observations: create, read, update
status: create, read, update enum (uncredited, credited, in_observation)
payment_code: create, read, update
payment_type: create, read, update enum (emitted_documents, auto_renovation, manual_activation)
months: create, read, update integer
updated_at: create, read, update

Relationships

plan: has one of type: plan

JSON Resource Example

  {
    data: {
      type: company_payments,
      id: 995,
      attributes: {
        amount: someValue,
        plan_id: someValue,
        description: someValue,
        observations: someValue,
        status: someValue,
        payment_code: someValue,
        payment_type: someValue,
        months: someValue,
        updated_at: someValue
        },
      relationships: { 
         plan:{
          id: 654,
          type: plan
        }
      }
    }
  }

JSON-API Entry points

DELETE PATCH GET https://api.multinexo.comcompanies/{company_id}/company_payments/{resource_id}

POST https://api.multinexo.comcompanies/{company_id}/company_payments/