Recibos - Procurar
—
Este endpoint destina-se exclusivamente a consultas pontuais e esporádicas. Não deve ser utilizado para pesquisas contínuas, polling periódico
ou como mecanismo de listagem de dados. Para mais informações, leia a documentação da página
Propósito da API.
value
mixed
required
Valor a procurar
search_in
string
required
Determina em que campo deve ser procurado. Deve ser enviado um dos seguintes valores: ID, Document Number ou
External Reference. No caso da procura ser efectuada no nº do documento, a seguinte nomenclatura exemplo deve ser enviada:
RG A/4921.
URL
https://facturalusa.pt/api/v2/receipts/find
Método
post
Resposta
200
{
"id": integer,
"number": integer,
"issue_date": string,
"receipt_date": string,
"serie_id": integer,
"document_type_id": integer,
"document_full_number": string,
"total_discount": decimal,
"total_balance": decimal,
"total_paid": decimal,
"grand_total": decimal,
"grand_total_with_currency_exchange": decimal,
"customer_id": integer,
"customer_code": string,
"customer_name": string,
"customer_vat_number": string,
"customer_country": string,
"customer_city": string,
"customer_address": string,
"customer_postal_code": string,
"company_name": string,
"company_vat_number": string,
"company_country": string,
"company_address": string,
"company_city": string,
"company_postal_code": string,
"payment_method_id": integer,
"currency_id": integer,
"currency_exchange": decimal,
"observations": string,
"external_reference": string,
"url_file": string,
"file_previewed": boolean,
"file_language": string,
"file_format": string,
"email_sent": boolean,
"sms_sent": boolean,
"status": string,
"signed": boolean,
"signed_id": integer,
"sign_attempt": integer,
"sign_error": string,
"created_by": integer,
"finished_by": integer,
"finished_at": string,
"canceled_by": integer,
"canceled_at": string,
"canceled_reason": string,
"updated_at": string,
"created_at": string,
"serie": {
"id": integer,
"description": string,
"valid_until": string
},
"documenttype": {
"id": integer,
"description": string,
"saft_initials": string,
"type": string,
"print_report": string,
"print_report_width": integer,
"print_pages_number": boolean,
"print_automatic": boolean,
"print_margin_top": integer,
"print_margin_right": integer,
"print_margin_left": integer,
"print_margin_bottom": integer,
"stock_check_negative": boolean,
"stock_check_minimum": boolean,
"send_email_automatic": boolean,
"send_sms_automatic": boolean,
"sign_document_automatic": boolean,
"active": boolean,
"updated_at": string,
"created_at": string
},
"documenttypeserie": {
"id": integer,
"document_type_id": integer,
"serie_id": integer,
"document_number": integer,
"atcud": string
},
"customer": {
"id": integer,
"code": string,
"name": string,
"vat_number": string,
"country": string,
"address": string,
"city": string,
"postal_code": string,
"email": string,
"telephone": string,
"mobile": string,
"currency_id": integer,
"payment_method_id": integer,
"payment_condition_id": integer,
"shipping_mode_id": integer,
"price_id": integer,
"employee_id": integer,
"type": string,
"vat_exemption_id": integer,
"vat_type": string,
"irs_retention_tax": decimal,
"observations": string,
"other_contacts": string,
"other_emails": string,
"code_blocked": boolean,
"vat_number_blocked": boolean,
"name_blocked": boolean,
"receive_sms": boolean,
"receive_emails": boolean,
"language": string,
"active": boolean,
"updated_at": string,
"created_at": string
},
"customercountry": {
"id": integer,
"name": string,
"code_iso_one": string
},
"paymentmethod": {
"id": integer,
"description": string,
"description_english": string
},
"currency": {
"id": integer,
"description": string,
"symbol": string,
"code_iso": string
},
"sales": [
{
"id": integer,
"sale_id": integer,
"total_balance": decimal,
"discount": decimal,
"discount_type": string,
"total_discount": decimal,
"total_paid": decimal,
"grand_total": decimal,
"sale": {
"id": integer,
"number": integer,
"issue_date": string,
"due_date": string,
"serie_id": integer,
"document_type_id": integer,
"document_full_number": string,
"grand_total": decimal,
"status": string,
"serie": {
"id": integer,
"description": string,
"valid_until": string
},
"documenttype": {
"id": integer,
"description": string,
"saft_initials": string,
"type": string
}
},
"deposit": {
"id": integer,
"document_full_number": string,
"net_total": decimal,
"total_vat": decimal,
"grand_total": decimal
}
}
],
"createdby": {
"id": integer,
"name": string,
"firstname": string,
"lastname": string,
"email": string
},
"finishedby": {
"id": integer,
"name": string,
"firstname": string,
"lastname": string,
"email": string
},
"canceledby": {
"id": integer,
"name": string,
"firstname": string,
"lastname": string,
"email": string
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.