sc-cobre-facil/dist/interfaces/CreateCustomerParams.d.ts

Biblioteca TypeScript para consumir a API da Cobre Fácil

/**
 * Parameters for creating a customer.
 *
 * @property person_type - The type of person. Use `1` for "Pessoa física" (individual) and `2` for "Pessoa jurídica" (legal entity).
 * @property ein - The Employer Identification Number (EIN). Required if the person is a legal entity.
 * @property company_name - The name of the company. Required if the person is a legal entity.
 * @property taxpayer_id - The taxpayer identification number. Required if the person is an individual.
 * @property personal_name - The name of the individual. Required if the person is an individual.
 * @property telephone - The telephone number of the customer.
 * @property cellular - The cellular phone number of the customer.
 * @property email - The email address of the customer.
 * @property email_cc - The email address for carbon copy (CC).
 * @property address - The address details of the customer.
 * @property address.description - A description of the address.
 * @property address.zipcode - The postal code of the address.
 * @property address.street - The street name of the address.
 * @property address.number - The number of the address.
 * @property address.complement - Additional address information (optional).
 * @property address.neighborhood - The neighborhood of the address.
 * @property address.city - The city of the address.
 * @property address.state - The state of the address.
 * @property nfse - Information related to NFSe (Nota Fiscal de Serviços Eletrônica) (optional).
 * @property nfse.inscricao_estadual - The state registration number (optional).
 * @property nfse.responsavel_retencao - The retention responsibility. Use `1` for "Tomador" (service taker) and `2` for "Intermediário" (intermediary) (optional).
 * @property nfse.iss - ISS (Imposto Sobre Serviços) details (optional).
 * @property nfse.iss.tipo_tributacao - The type of taxation. Accepts values as per specification (optional).
 * @property nfse.iss.exigibilidade - The tax exigibility. Accepts values as per specification (optional).
 * @property nfse.iss.retido - Indicates whether the tax is withheld (optional).
 * @property nfse.iss.processo_suspensao - The suspension process identifier (optional).
 */
export interface CreateCustomerParams {
    person_type: 1 | 2;
    ein?: string;
    company_name?: string;
    taxpayer_id?: string;
    personal_name?: string;
    telephone?: string;
    cellular?: string;
    email?: string;
    email_cc?: string;
    address: {
        description: string;
        zipcode: string;
        street: string;
        number: string;
        complement?: string;
        neighborhood: string;
        city: string;
        state: string;
    };
    nfse?: {
        inscricao_estadual?: string;
        responsavel_retencao?: 1 | 2;
        iss?: {
            tipo_tributacao?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
            exigibilidade?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
            retido?: boolean;
            processo_suspensao?: string;
        };
    };
}
//# sourceMappingURL=CreateCustomerParams.d.ts.map