API

API mub | BP - Get details BP

This article is itended to document the API mub | BP - Get details BP Route: POST => http://api.mub.cloud/api/v2/bp/<id> See below full object of request and expected response. Return example: Route: POST => …

Moises ScarpinPublicado 08 de fev. de 20245 min de leitura

This article is itended to document the API mub | BP - Get details BP

Route: POST => http://api.mub.cloud/api/v2/bp/<id>

See below full object of request and expected response.

Return example:

{
    "success"true,
    "message""BP Generals successfully displayed!",
    "data": {
        "id"1,
        "code""CODE01",
        "description""apple inc. (apple)",
        "type""ORGANIZATION",
        "countries_continents_regions_generals_id"236,
        "company_name""Apple Inc.",
        "company_trade_name""Apple",
        "company_foundation_date""1978-01-31 00:00:00",
        "bp_aux_person_titles_id"null,
        "person_first_name"null,
        "person_last_name"null,
        "person_birth_date"null,
        "status""A",
        "partner_functions_ids": [
            1,
            2,
            3
        ],
        "updated_at""2021-11-11 18:13:03",
        "bp_documents": [
            {
                "id"67,
                "bp_aux_document_types_id""CPF",
                "bp_aux_document_status_id"null,
                "category""DOCUMENTATION",
                "identification""96228962000",
                "issuer""SP-RS",
                "situacao""ATIVO",
                "valid_from""2021-10-29 00:00:00",
                "valid_to""2999-12-31 00:00:00",
                "consulted_at""2021-10-29 00:00:00",
                "url_upload_file": [
                    {
                        "url""mubdafb0cb7a14a4253b91e5df8bfd0acfc/617bff8ba1f01.xlsx",
                        "description""cities.xlsx",
                        "file_name""cities.xlsx",
                        "file_size""164.76 kB",
                        "file_type""xlsx",
                        "file_extension""xlsx",
                        "file_mime_type""application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
                    },
                    {
                        "url""mubdafb0cb7a14a4253b91e5df8bfd0acfc/617bff9cee397.pdf",
                        "description""Resenha-–-A-Fórmula-Mágica-de-Joel-Greenblatt-para-Bater-o-Mercado-de-Ações-.pdf",
                        "file_name""Resenha-–-A-Fórmula-Mágica-de-Joel-Greenblatt-para-Bater-o-Mercado-de-Ações-.pdf",
                        "file_size""430.63 kB",
                        "file_type""pdf",
                        "file_extension""pdf",
                        "file_mime_type""application/pdf"
                    },
                    {
                        "url""mubdafb0cb7a14a4253b91e5df8bfd0acfc/617bffabcec99.png",
                        "description""logo-png-alta.png",
                        "file_name""logo-png-alta.png",
                        "file_size""20.43 kB",
                        "file_type""png",
                        "file_extension""png",
                        "file_mime_type""image/png"
                    }
                ]
            }
        ],
        "bp_addresses": [
            {
                "id"232,
                "bp_aux_addresses_types_id""MAIN",
                "address_line_1""One Apple Park Way",
                "address_line_2""Apple Building",
                "number""1",
                "complement""All Build",
                "postal_code""95014",
                "district""One Apple Park Way District",
                "valid_from""2020-01-01 00:00:00",
                "valid_to""2030-01-01 00:00:00",
                "countries_continents_regions_generals_id""us",
                "states_generals_id"null,
                "cities_generals_id"null,
                "bp_addresses_comments": []
            }
        ],
        "bp_contacts": [],
        "bp_bank_accounts": [
            {
                "id"232,
                "bp_aux_bank_accounts_categories_id""MAIN",
                "city""São Paulo",
                "address""Av. Paulista",
                "br_account_type""281",
                "bp_aux_br_bank_codes_id""001",
                "br_branch_code""1445",
                "br_branch_digit""8",
                "br_account_number""111544",
                "br_account_digit""7",
                "foreing_account_type"null,
                "aba_code""ABA-879",
                "iban_code""IBAN-564",
                "swift_bic_code""BIC0-546",
                "status""A",
                "pix""942404110",
                "countries_continents_regions_generals_id""br",
                "created_at""2021-11-11 18:13:03",
                "updated_at""2021-11-11 18:13:03",
                "bp_bank_accounts_comments": []
            },
            {
                "id"233,
                "bp_aux_bank_accounts_categories_id""MAIN",
                "city""Cupertino",
                "address""3ª Street, 74",
                "br_account_type"null,
                "bp_aux_br_bank_codes_id"null,
                "br_branch_code""7411",
                "br_branch_digit"null,
                "br_account_number""111544",
                "br_account_digit"null,
                "foreing_account_type"null,
                "aba_code""ABA-546",
                "iban_code""IBAN-213",
                "swift_bic_code""BIC0-147",
                "status""A",
                "pix"null,
                "countries_continents_regions_generals_id""us",
                "created_at""2021-11-11 18:13:03",
                "updated_at""2021-11-11 18:13:03",
                "bp_bank_accounts_comments": []
            }
        ],
        "bp_taxes": [
            {
                "id"232,
                "br_cnae_principal_id""5222-2/00",
                "br_cnaes_secundarios_ids": [],
                "bp_aux_br_tipo_tributacoes_id"null,
                "bp_aux_br_natureza_juridicas_id"null,
                "created_at""2021-11-11 18:13:03",
                "updated_at""2021-11-11 18:13:03"
            }
        ],
        "bp_market_categories": [
            {
                "id"232,
                "identification""03046210",
                "superior_category_code""TIPI",
                "description""03046210 - 03046210 - 03046210 - Filés (Filetes*) de tilápias (Oreochromis spp.), bagres (peixes-gato*) (Pangasius spp., Silurus spp., Clarias spp., Ictalurus spp.), carpas (Cyprinus spp., Carassius spp., Ctenopharyngodon idellus, Hypophthalmichthys spp., Cirrhinus spp., Mylopharyngodon piceus, Catla catla, Labeo spp., Osteochilus hasselti, Leptobarbus hoeveni, Megalobrama spp.), enguias (Anguilla spp.), perca-do-nilo (Lates niloticus) e peixes cabeça-de-serpente (Channa spp.), congelados: Bagres (Peixes-gato*) (Pangasius spp., Silurus spp., Clarias spp., Ictalurus spp.) - Bagre americano (Ictalurus punctatus)",
                "created_at""2021-11-11 18:13:04",
                "updated_at""2021-11-11 18:13:04"
            }
        ],
        "bp_markets": [
            {
                "id"232,
                "operation_locations": [
                    {
                        "description""USA"
                    },
                    {
                        "description""BRAZIL"
                    },
                    {
                        "description""EUROPE"
                    }
                ],
                "delivery_locations": [
                    {
                        "description""USA"
                    },
                    {
                        "description""BRAZIL"
                    },
                    {
                        "description""EUROPE"
                    }
                ],
                "main_vendors": [
                    {
                        "description""USA"
                    },
                    {
                        "description""BRAZIL"
                    },
                    {
                        "description""EUROPE"
                    }
                ],
                "main_competitors": [
                    {
                        "description""USA"
                    },
                    {
                        "description""BRAZIL"
                    },
                    {
                        "description""EUROPE"
                    }
                ],
                "main_customers": [
                    {
                        "name""USA",
                        "percentage"88.54
                    },
                    {
                        "name""Brazils",
                        "percentage"9
                    },
                    {
                        "name""Europe",
                        "percentage"3
                    }
                ],
                "size""EGP",
                "employees_quantity""MORE_10K",
                "created_at""2021-11-11 18:13:03",
                "updated_at""2021-11-11 18:13:03",
                "annual_gross_billing": [
                    {
                        "annual_gross_billing_year"2020,
                        "annual_gross_billing_month"12,
                        "annual_gross_billing_value"12345678.32,
                        "annual_gross_billing_currencies_generals_id""USD"
                    }
                ]
            }
        ],
        "bp_marketings": [
            {
                "id"1,
                "website""https://www.empresa.com",
                "logo_url_upload_file"null,
                "reduced_logo_url_upload_file"null,
                "description""Um texto longo em br",
                "created_at""2021-09-21 08:18:54",
                "updated_at""2021-09-21 08:18:54",
                "languages": [
                    {
                        "id"232,
                        "languages_generals_id""en-US",
                        "description""Long text in Brazilian Portuguese",
                        "created_at""2021-11-11 18:13:04",
                        "updated_at""2021-11-11 18:13:04"
                    }
                ]
            }
        ],
        "bp_social_medias": [
            {
                "id"265,
                "bp_aux_social_medias_types_id""FACEBOOK",
                "url""https://facebook.com/apple",
                "created_at""2021-11-11 18:13:04",
                "updated_at""2021-11-11 18:13:04"
            },
            {
                "id"266,
                "bp_aux_social_medias_types_id""INSTAGRAM",
                "url""https://instagram.com/apple",
                "created_at""2021-11-11 18:13:04",
                "updated_at""2021-11-11 18:13:04"
            },
            {
                "id"267,
                "bp_aux_social_medias_types_id""YOUTUBE",
                "url""https://www.youtube.com/apple",
                "created_at""2021-11-11 18:13:04",
                "updated_at""2021-11-11 18:13:04"
            }
        ],
        "bp_shareholders": [
            {
                "id"265,
                "shareholder_bp_generals_id"null,
                "full_name""Steve Jobs",
                "shares_percentage""55.00",
                "created_at""2021-11-11 18:13:04",
                "updated_at""2021-11-11 18:13:04"
            },
            {
                "id"266,
                "shareholder_bp_generals_id"null,
                "full_name""Tim Cock",
                "shares_percentage""45.00",
                "created_at""2021-11-11 18:13:04",
                "updated_at""2021-11-11 18:13:04"
            }
        ],
        "bp_executives": [
            {
                "id"232,
                "executive_bp_generals_id"null,
                "full_name""Steve Jobs",
                "bp_aux_executive_positions_id"null,
                "observations""Member of Concil",
                "created_at""2021-11-11 18:13:04",
                "updated_at""2021-11-11 18:13:04"
            }
        ],
        "bp_relations": [],
        "bp3rd_part_requests": [],
        "tags": [],
        "additional_fields_objects": [
            {
                "36bc9946-df2a-fc29-2097-682fc29257dd": {
                    "description""SAP123"
                }
            }
        ]
    }
}