getByMBReference

Disponível na versão: 1.26+

Permite efetuar a pesquisa de um documento através da referência multibanco.

Pedido

https://api.moloni.pt/v1/documents/getByMBReference/?access_token=[current_access_token]

Parâmetros
company_id int

Required

entity int

Required 

reference int

Required 

Nota
- O parâmetro qty tem como default 50 e o offset 0, sendo que o máximo qty é 50;
- Campos de preenchimento facultativo, significa que podem ser uma string vazia ou zero, dependendo do respectivo tipo.
Resposta
{
    "lastmodifiedby": string,
    "lastmodifiedby_id": int,
    "lastmodified": string,
    "set_from_api": int,
    "plugin_id": int,
    "doc_unico": string,
    "terminal_id": int,
    "cash_vat_scheme_indicator":int,
    "rsa_hash": string,
    "hash_control": int,
    "timezone_id": int,
    "document_id": int,
    "company_id": int,
    "document_type_id": int,
    "customer_id": int,
    "supplier_id": int,
    "salesman_id": int,
    "document_set_id": int,
    "document_set_name": string,
    "number": int,
    "date": string,
    "expiration_date": string,
    "year": int,
    "maturity_date_days": int,
    "maturity_date_id": int,
    "maturity_date_name": string,
    "your_reference": string,
    "our_reference": string,
    "entity_number": string,
    "entity_name": string,
    "entity_vat": string,
    "entity_address": string,
    "entity_city": string,
    "entity_zip_code": string,
    "entity_country": string,
    "entity_country_id": int,
    "cash_vat_scheme_entity": int,
    "alternate_address_id": int,
    "attached_file": string,
    "notes": string,
    "salesman_commission": float,
    "deduction_id": int,
    "deduction_percentage": float,
    "deduction_name": string,
    "special_discount": float,
    "financial_discount": float,
    "gross_value": float,
    "comercial_discount_value": float,
    "financial_discount_value": float,
    "taxes_value": float,
    "deduction_value": float,
    "net_value": float,
    "reconciled_value": float,
    "eac_id": 0,
    "eac_code": string,
    "delivery_method_id": int,
    "delivery_method_name": string,
    "vehicle_id": int,
    "vehicle_name": string,
    "vehicle_number_plate": string,
    "delivery_datetime": string,
    "delivery_departure_address": string,
    "delivery_departure_city": string,
    "delivery_departure_zip_code": string,
    "delivery_departure_country": int,
    "delivery_destination_address": string,
    "delivery_destination_city": string,
    "delivery_destination_zip_code": string,
    "delivery_destination_country": int,
    "related_documents_notes": string,
    "status": int,
    "transport_code": string,
    "transport_code_set_by": int,
    "global_guide": int,
    "generate_mb_reference": int,
    "exchange_currency_id": int,
    "exchange_total_value": float,
    "exchange_rate": float,
    "atcud": string,
    "paperless": int,
    "document_type": {
        "document_type_id": int,
        "saft_code": string
    },
    "document_set": {
        "document_set_id": int,
        "name": string,
        "template": {
            "template_id": iut,
            "email": string,
            "fax": string,
            "website": string,
            "name": string
            "business_name": string,
            "address": string,
            "city": string,
            "zip_code": string
            "country_id": int,
            "phone": string,
            "notes": string1,
            "documents_footnote": string,
            "email_sender_name": string,
            "email_sender_address": string,
            "image": string,
            "phone_description": string,
            "country": {
                "iso_3166_1": string,
                "country_id": int,
                "name": string,
                "image": string
            }
        }
    },
    "salesman": {
        "salesman_id": int,
        "number": string,
        "name": string,
        "vat": string
    },
    "products": [
        {
            "ean": string,
            "document_product_id": int,
            "origin_id": int,
            "order": int,
            "product_id": int,
            "category_id": int,
            "reference": string,
            "name": string,
            "summary": string,
            "price": float,
            "price_class_id": int,
            "unit_id": int,
            "unit_name": string,
            "unit_short_name": string,
            "discount": float,
            "qty": int,
            "deduction_id": 0,
            "exemption_reason": string
            "deduction": float,
            "deduction_name": string,
            "warehouse_id": int,
            "properties": string,
            "parent_id": int,
            "related_id": int,
            "taxes": [
                {
                    "tax_id": int,
                    "type": int,
                    "saft_type": int,
                    "vat_type": string,
                    "stamp_tax": string,
                    "name": string,
                    "value": int,
                    "fiscal_zone": string,
                    "order": int,
                    "cumulative": int,
                    "incidence_value": float,
                    "total_value": float
                }
            ]
        }
    ],
    "associated_documents": [],
    "reverse_associated_documents": [],
    "mb_references": [
        {
            "check_digits": int,
            "reference_id": int,
            "entity": int,
            "sub_entity": int,
            "reference": int,
            "creation_date": string,
            "payment_date": string,
            "value": float,
            "paid": int
        }
    ],
    "payments": [],
    "document_calc_method": {
        "document_id": int,
        "calc_method_id": int
    }
}
Lista de erros possíveis
Sempre que existir um erro no preenchimento dos campos, será devolvido via JSON o objeto com os erros indexado pela ordem dos campos.
As mensagens de erro, são devolvidas sob a forma de códigos, e para perceber quais os erros disponíveis e como interpretar as mensagens recebidas, consulte esta ligação.

© 2025 Moloni

Software de faturação online

Certificado pela Autoridade Tributária N.º 2860