documents resource

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

Attributes

cae: create, read, update
cae_expiration_date: create, read, update
net: create, read, update numeric
total: create, read, update numeric
observation: create, read, update
discount_percent: create, read, update numeric
discount_amount: create, read, update numeric
pdf_url: create, read, update
canceled: create, read, update
fiscal_observation: create, read, update
show_amounts: create, read, update boolean
emission_date: create, read, update EmissionDateFilter Sortable
section: create, read, update in [sales, purchases] EnumFilter Sortable
receipt_type: create, read, update in [invoice, credit, debit, order_sell, order_buy, no_fiscal, quotation, zeta] EnumFilter Sortable
status: create, read, update in [draft, failed, queued, confirmed] EnumFilter Sortable
letter: read LetterFilter Sortable
receipt_volume: create, read, update integer StringFilter Sortable
receipt_number: create, read, update integer StringFilter Sortable
has_costs: read HasCostsFilter Sortable

Relationships

details: has one of type: details
currency: has one of type: currency
entity: has one of type: entity
physicalpos: has one of type: physicalpos
closureReceipt: has one of type: closureReceipt
cashier_entries: has one of type: cashier_entries
receipt: has one of type: receipt
documents: has one of type: documents
costs: has one of type: costs
seller: has one of type: seller

Filter example

https://api.multinexo.comcompanies/{company_id}/documents?filter[emission_date]=someValue

JSON Resource Example

  {
    data: {
      type: documents,
      id: 103,
      attributes: {
        cae: someValue,
        cae_expiration_date: someValue,
        net: someValue,
        total: someValue,
        observation: someValue,
        discount_percent: someValue,
        discount_amount: someValue,
        pdf_url: someValue,
        canceled: someValue,
        fiscal_observation: someValue,
        show_amounts: true,
        emission_date: someValue,
        section: someValue,
        receipt_type: someValue,
        status: someValue,
        letter: someValue,
        receipt_volume: someValue,
        receipt_number: someValue,
        has_costs: someValue
        },
      relationships: { 
         details:{
          id: 228,
          type: details
        },
      
         currency:{
          id: 554,
          type: currency
        },
      
         entity:{
          id: 448,
          type: entity
        },
      
         physicalpos:{
          id: 484,
          type: physicalpos
        },
      
         closureReceipt:{
          id: 920,
          type: closureReceipt
        },
      
         cashier_entries:{
          id: 760,
          type: cashier_entries
        },
      
         receipt:{
          id: 377,
          type: receipt
        },
      
         documents:{
          id: 123,
          type: documents
        },
      
         costs:{
          id: 449,
          type: costs
        },
      
         seller:{
          id: 936,
          type: seller
        }
      }
    }
  }

JSON-API Entry points

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

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