export declare const ApiAccountDocumentUpdateRequestDTOSchema: { readonly required: readonly ["documentFile"]; readonly type: "object"; readonly properties: { readonly documentFile: { readonly $ref: "#/components/schemas/File"; }; }; }; export declare const FileSchema: { readonly required: readonly ["documentFile"]; readonly type: "string"; readonly description: "File"; readonly format: "binary"; readonly deprecated: false; readonly example: null; }; export declare const ApiAccountDocumentGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique document identifier in Asaas"; readonly example: "8d257732-2220-11ec-b695-b6af4a64184d"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiAccountDocumentGetResponseCustomerDocumentStatus"; }; }; }; export declare const ApiAccountDocumentGetResponseCustomerDocumentStatusSchema: { readonly type: "string"; readonly description: "Document approval status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["NOT_SENT", "PENDING", "APPROVED", "REJECTED"]; }; export declare const ApiAccountDocumentDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the document was removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique document identifier in Asaas"; readonly example: "8d257732-2220-11ec-b695-b6af4a64184d"; readonly deprecated: false; }; }; }; export declare const ApiAccountDocumentShowResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly rejectReasons: { readonly type: "string"; readonly description: "Reason why account approval was rejected"; readonly deprecated: false; readonly example: null; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique document group identifier in Asaas"; readonly example: "172ed152-4fa4-43ad-9b69-39c323e9526c"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiAccountDocumentGroupResponseCustomerDocumentStatus"; }; readonly type: { readonly $ref: "#/components/schemas/ApiAccountDocumentGroupResponseCustomerDocumentType"; }; readonly title: { readonly type: "string"; readonly description: "Document group title"; readonly example: "Minutes of election of the last board"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Description"; readonly example: "No description"; readonly deprecated: false; }; readonly responsible: { readonly $ref: "#/components/schemas/ApiAccountDocumentGroupResponsibleResponseDTO"; }; readonly onboardingUrl: { readonly type: "string"; readonly description: "URL for sending documents"; readonly example: "https://cadastro.io/8ad196d6cbfcc5d05bfabcbb5c730f6a"; readonly deprecated: false; }; readonly onboardingUrlExpirationDate: { readonly type: "string"; readonly description: "Expiration date of the URL for sending documents"; readonly format: "date-time"; readonly example: "2025-03-04 00:00:00"; readonly deprecated: false; }; readonly documents: { readonly type: "array"; readonly description: "Documents that have already been sent with their respective identifiers"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiAccountDocumentGetResponseDTO"; }; }; }; }; }; }; }; export declare const ApiAccountDocumentGroupResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique document group identifier in Asaas"; readonly example: "172ed152-4fa4-43ad-9b69-39c323e9526c"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiAccountDocumentGroupResponseCustomerDocumentStatus"; }; readonly type: { readonly $ref: "#/components/schemas/ApiAccountDocumentGroupResponseCustomerDocumentType"; }; readonly title: { readonly type: "string"; readonly description: "Document group title"; readonly example: "Minutes of election of the last board"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Description"; readonly example: "No description"; readonly deprecated: false; }; readonly responsible: { readonly $ref: "#/components/schemas/ApiAccountDocumentGroupResponsibleResponseDTO"; }; readonly onboardingUrl: { readonly type: "string"; readonly description: "URL for sending documents"; readonly example: "https://cadastro.io/8ad196d6cbfcc5d05bfabcbb5c730f6a"; readonly deprecated: false; }; readonly onboardingUrlExpirationDate: { readonly type: "string"; readonly description: "Expiration date of the URL for sending documents"; readonly format: "date-time"; readonly example: "2025-03-04 00:00:00"; readonly deprecated: false; }; readonly documents: { readonly type: "array"; readonly description: "Documents that have already been sent with their respective identifiers"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiAccountDocumentGetResponseDTO"; }; }; }; }; export declare const ApiAccountDocumentGroupResponseCustomerDocumentStatusSchema: { readonly type: "string"; readonly description: "Document group status"; readonly example: "NOT_SENT"; readonly deprecated: false; readonly enum: readonly ["NOT_SENT", "PENDING", "APPROVED", "REJECTED", "IGNORED"]; }; export declare const ApiAccountDocumentGroupResponseCustomerDocumentTypeSchema: { readonly type: "string"; readonly description: "Type of documents"; readonly example: "MINUTES_OF_CONSTITUTION"; readonly deprecated: false; readonly enum: readonly ["IDENTIFICATION", "SOCIAL_CONTRACT", "ENTREPRENEUR_REQUIREMENT", "MINUTES_OF_ELECTION", "CUSTOM"]; }; export declare const ApiAccountDocumentGroupResponsibleResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Responsible name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly type: { readonly type: "array"; readonly description: "Responsible tyoe"; readonly example: "ASSOCIATION"; readonly deprecated: false; readonly items: { readonly type: "string"; }; readonly enum: readonly ["ALLOW_BANK_ACCOUNT_DEPOSIT_STATEMENT", "ASAAS_ACCOUNT_OWNER_EMANCIPATION_AGE", "ASAAS_ACCOUNT_OWNER", "ASSOCIATION", "BANK_ACCOUNT_OWNER_EMANCIPATION_AGE", "BANK_ACCOUNT_OWNER", "CUSTOM", "DIRECTOR", "INDIVIDUAL_COMPANY", "LIMITED_COMPANY", "MEI", "PARTNER"]; }; }; readonly description: "Who is responsible for sending these documents"; readonly deprecated: false; }; export declare const ApiAccountDocumentGroupResponsibleResponseCustomerDocumentGroupTypeSchema: { readonly type: "string"; }; export declare const ApiAccountDocumentSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly documentFile: { readonly $ref: "#/components/schemas/File"; }; readonly type: { readonly $ref: "#/components/schemas/ApiAccountDocumentSaveRequestCustomerDocumentType"; }; }; }; export declare const ApiAccountDocumentSaveRequestCustomerDocumentTypeSchema: { readonly type: "string"; readonly description: "Document Type"; readonly example: "IDENTIFICATION"; readonly deprecated: false; readonly enum: readonly ["IDENTIFICATION", "SOCIAL_CONTRACT", "ENTREPRENEUR_REQUIREMENT", "MINUTES_OF_ELECTION", "CUSTOM"]; }; export declare const ApiBillCancelRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiBillGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "bill"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique bill payment identifier in Asaas"; readonly example: "f1bce822-6f37-4905-8de8-f1af9f2f4bab"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiBillGetResponseBillStatus"; }; readonly value: { readonly type: "number"; readonly description: "Amount to be paid"; readonly example: 29; readonly deprecated: false; }; readonly discount: { readonly type: "number"; readonly description: "Discount attributed to payment"; readonly example: 0; readonly deprecated: false; }; readonly interest: { readonly type: "number"; readonly description: "Interest attributed to payment"; readonly example: 0; readonly deprecated: false; }; readonly fine: { readonly type: "number"; readonly description: "Fine assigned to payment"; readonly example: 0; readonly deprecated: false; }; readonly identificationField: { readonly type: "string"; readonly description: "Typeable line of the bill to be paid"; readonly example: "03399.77779 29900.000000 04751.101017 1 81510000002990"; readonly deprecated: false; }; readonly dueDate: { readonly type: "string"; readonly description: "Billing due date"; readonly format: "date"; readonly example: "2020-01-31"; readonly deprecated: false; }; readonly scheduleDate: { readonly type: "string"; readonly description: "Payment scheduling date"; readonly format: "date"; readonly example: "2020-01-31"; readonly deprecated: false; }; readonly paymentDate: { readonly type: "string"; readonly description: "Date on which payment was made"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly fee: { readonly type: "number"; readonly description: "Asaas fee for bill payment"; readonly example: 0; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Bill Payment Description"; readonly example: "Celular 01/12"; readonly deprecated: false; }; readonly companyName: { readonly type: "string"; readonly description: "Company/Body issuing the payment"; readonly deprecated: false; readonly example: null; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "Proof of bill payment"; readonly example: "https://www.asaas.com/comprovantes/00016578"; readonly deprecated: false; }; readonly canBeCancelled: { readonly type: "boolean"; readonly description: "Whether payment can be canceled"; readonly example: false; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Unique identifier of the bill in your system"; readonly deprecated: false; readonly example: null; }; readonly failReasons: { readonly type: "array"; readonly description: "List of reasons for payment failure"; readonly deprecated: false; readonly items: { readonly type: "string"; }; }; }; }; export declare const ApiBillGetResponseBillStatusSchema: { readonly type: "string"; readonly description: "Bill payment status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "BANK_PROCESSING", "PAID", "FAILED", "CANCELLED", "REFUNDED", "AWAITING_CHECKOUT_RISK_ANALYSIS_REQUEST"]; }; export declare const ApiBillSaveRequestDTOSchema: { readonly required: readonly ["identificationField"]; readonly type: "object"; readonly properties: { readonly identificationField: { readonly required: readonly ["identificationField"]; readonly type: "string"; readonly description: "Digitizable bill line"; readonly example: "03399.77779 29900.000000 04751.101017 1 81510000002990"; readonly deprecated: false; }; readonly scheduleDate: { readonly type: "string"; readonly description: "Payment scheduling date"; readonly example: "2020-03-15"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Bill Payment Description"; readonly example: "Celular 03/12"; readonly deprecated: false; }; readonly discount: { readonly type: "number"; readonly description: "Discount attributed to payment"; readonly example: 0; readonly deprecated: false; }; readonly interest: { readonly type: "number"; readonly description: "Interest attributed to payment"; readonly example: 0; readonly deprecated: false; }; readonly fine: { readonly type: "number"; readonly description: "Fine assigned to payment"; readonly example: 0; readonly deprecated: false; }; readonly dueDate: { readonly type: "string"; readonly description: "Expiration date of the account if it is the type that does not have this information"; readonly format: "date"; readonly example: "2020-03-30"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Account value if it is the type that does not have this information (Ex: credit card invoices)"; readonly example: 29; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Unique identifier of the bill in your system"; readonly example: "056984"; readonly deprecated: false; }; }; }; export declare const ApiBillListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiBillGetResponseDTO"; }; }; }; }; export declare const ApiBillSimulateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly identificationField: { readonly type: "string"; readonly description: "Digitizable bill line"; readonly example: "03399.77779 29900.000000 04751.101017 1 81510000002990"; readonly deprecated: false; }; readonly barCode: { readonly type: "string"; readonly description: "Ticket barcode"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiBillSimulateResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly minimumScheduleDate: { readonly type: "string"; readonly description: "Minimum date allowed for scheduling"; readonly format: "date"; readonly example: "2021-11-22"; readonly deprecated: false; }; readonly fee: { readonly type: "number"; readonly description: "Fee charged when paying the bill"; readonly example: 0; readonly deprecated: false; }; readonly bankSlipInfo: { readonly $ref: "#/components/schemas/ApiBillSimulateBankSlipInfoResponseDTO"; }; }; }; export declare const ApiBillSimulateBankSlipInfoResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly identificationField: { readonly type: "string"; readonly description: "Digitable line"; readonly example: "03399201595100529040147600301023888440000421177"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Ticket value"; readonly example: 4211.77; readonly deprecated: false; }; readonly dueDate: { readonly type: "string"; readonly description: "Due date"; readonly format: "date"; readonly example: "2021-12-24"; readonly deprecated: false; }; readonly companyName: { readonly type: "string"; readonly description: "Company/Body issuing the bill"; readonly deprecated: false; readonly example: null; }; readonly bank: { readonly type: "string"; readonly description: "Code of the bank issuing the bill in the banking system"; readonly example: "033"; readonly deprecated: false; }; readonly beneficiaryCpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the beneficiary"; readonly example: "19.540.550/0001-21"; readonly deprecated: false; }; readonly beneficiaryName: { readonly type: "string"; readonly description: "Beneficiary's name"; readonly example: "ASAAS GESTAO FINANCEIRA S.A."; readonly deprecated: false; }; readonly allowChangeValue: { readonly type: "boolean"; readonly description: "Whether the value can be changed or not"; readonly example: false; readonly deprecated: false; }; readonly minValue: { readonly type: "number"; readonly description: "Minimum value that can be changed"; readonly example: 4211.77; readonly deprecated: false; }; readonly maxValue: { readonly type: "number"; readonly description: "Maximum value that can be changed"; readonly example: 4211.77; readonly deprecated: false; }; readonly discountValue: { readonly type: "number"; readonly description: "Value of discounts"; readonly example: 0; readonly deprecated: false; }; readonly interestValue: { readonly type: "number"; readonly description: "Interest amount"; readonly example: 0; readonly deprecated: false; }; readonly fineValue: { readonly type: "number"; readonly description: "Fine value"; readonly example: 0; readonly deprecated: false; }; readonly originalValue: { readonly type: "number"; readonly description: "Original bill value"; readonly example: 4211.77; readonly deprecated: false; }; readonly totalDiscountValue: { readonly type: "number"; readonly description: "Total value of discounts and rebates"; readonly example: 0; readonly deprecated: false; }; readonly totalAdditionalValue: { readonly type: "number"; readonly description: "Total amount of interest and fine"; readonly example: 0; readonly deprecated: false; }; readonly isOverdue: { readonly type: "boolean"; readonly description: "Informs if the ticket is expired"; readonly example: false; readonly deprecated: false; }; }; readonly description: "Information about the bill to be paid"; readonly deprecated: false; }; export declare const ApiChargebackSaveDisputeRequestDTOSchema: { readonly required: readonly ["id", "files"]; readonly type: "object"; readonly properties: { readonly files: { readonly required: readonly ["files"]; readonly type: "string"; readonly description: "Files to create the dispute (Maximum: 11)."; readonly format: "binary"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiChargebackSaveDisputeResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly chargebackId: { readonly type: "string"; readonly description: "Unique identifier of chargeback for which the dispute will be created."; readonly example: "2765d086-c7c5-5cca-898a-4262d212587c"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiChargebackSaveDisputeResponseChargebackDisputeStatus"; }; readonly files: { readonly type: "array"; readonly description: "Names of the dispute files."; readonly deprecated: false; readonly items: { readonly type: "string"; }; }; }; }; export declare const ApiChargebackSaveDisputeResponseChargebackDisputeStatusSchema: { readonly type: "string"; readonly description: "Dispute status."; readonly example: "REQUESTED"; readonly deprecated: false; readonly enum: readonly ["REQUESTED", "ACCEPTED", "REJECTED"]; }; export declare const OpenApiErrorResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly errors: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Error code"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Error description"; readonly deprecated: false; readonly example: null; }; }; }; }; }; readonly example: { readonly errors: readonly [{ readonly code: "invalid_customer"; readonly description: "Customer Inválido ou não informado"; }]; }; }; export declare const OpenApiErrorResponseDataDTOSchema: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Error code"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Error description"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentChargebackResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique chargeback identifier."; readonly example: "8e784c3e-afe8-4844-bb93-6b445763"; readonly deprecated: false; }; readonly payment: { readonly type: "string"; readonly description: "Unique payment identifier in Asaas"; readonly example: "pay_pBtDdshgBD2Rt"; readonly deprecated: false; }; readonly installment: { readonly type: "string"; readonly description: "Unique installment identifier in Asaas"; readonly example: "b8dd74c-d078-40a0-9ae1-61a66c61a204"; readonly deprecated: false; }; readonly customerAccount: { readonly type: "string"; readonly description: "Unique identifier of customer to which the chargeback is linked."; readonly example: "cus_000000004085"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentChargebackResponseChargebackStatus"; }; readonly reason: { readonly $ref: "#/components/schemas/ApiPaymentChargebackResponseChargebackReason"; }; readonly disputeStartDate: { readonly type: "string"; readonly description: "Chargeback opening date."; readonly format: "date"; readonly example: "2024-11-10"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Chargeback value."; readonly example: 2323.45; readonly deprecated: false; }; readonly paymentDate: { readonly type: "string"; readonly description: "Payment date on Asaas"; readonly format: "date"; readonly example: "2024-03-10"; readonly deprecated: false; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiChargebackCreditCardResponseDTO"; }; readonly disputeStatus: { readonly $ref: "#/components/schemas/ApiPaymentChargebackResponseChargebackDisputeStatus"; }; readonly deadlineToSendDisputeDocuments: { readonly type: "string"; readonly description: "Deadline to send dispute documents."; readonly format: "date"; readonly example: "2024-12-10"; readonly deprecated: false; }; }; }; export declare const ApiPaymentChargebackResponseChargebackStatusSchema: { readonly type: "string"; readonly description: "Chargeback status"; readonly example: "DONE"; readonly deprecated: false; readonly enum: readonly ["REQUESTED", "IN_DISPUTE", "DISPUTE_LOST", "REVERSED", "DONE"]; }; export declare const ApiPaymentChargebackResponseChargebackReasonSchema: { readonly type: "string"; readonly description: "Chargeback reason"; readonly example: "COMMERCIAL_DISAGREEMENT"; readonly deprecated: false; readonly enum: readonly ["ABSENCE_OF_PRINT", "ABSENT_CARD_FRAUD", "CARD_ACTIVATED_PHONE_TRANSACTION", "CARD_FRAUD", "CARD_RECOVERY_BULLETIN", "COMMERCIAL_DISAGREEMENT", "COPY_NOT_RECEIVED", "CREDIT_OR_DEBIT_PRESENTATION_ERROR", "DIFFERENT_PAY_METHOD", "FRAUD", "INCORRECT_TRANSACTION_VALUE", "INVALID_CURRENCY", "INVALID_DATA", "LATE_PRESENTATION", "LOCAL_REGULATORY_OR_LEGAL_DISPUTE", "MULTIPLE_ROCS", "ORIGINAL_CREDIT_TRANSACTION_NOT_ACCEPTED", "OTHER_ABSENT_CARD_FRAUD", "PROCESS_ERROR", "RECEIVED_COPY_ILLEGIBLE_OR_INCOMPLETE", "RECURRENCE_CANCELED", "REQUIRED_AUTHORIZATION_NOT_GRANTED", "RIGHT_OF_FULL_RECOURSE_FOR_FRAUD", "SALE_CANCELED", "SERVICE_DISAGREEMENT_OR_DEFECTIVE_PRODUCT", "SERVICE_NOT_RECEIVED", "SPLIT_SALE", "TRANSFERS_OF_DIVERSE_RESPONSIBILITIES", "UNQUALIFIED_CAR_RENTAL_DEBIT", "USA_CARDHOLDER_DISPUTE", "VISA_FRAUD_MONITORING_PROGRAM", "WARNING_BULLETIN_FILE"]; }; export declare const ApiChargebackCreditCardResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly number: { readonly type: "string"; readonly description: "Last 4 digits of the card used"; readonly example: "8829"; readonly deprecated: false; }; readonly brand: { readonly $ref: "#/components/schemas/ApiChargebackCreditCardResponseCreditCardBrand"; }; }; readonly description: "Credit card information"; readonly deprecated: false; }; export declare const ApiChargebackCreditCardResponseCreditCardBrandSchema: { readonly type: "string"; readonly description: "Flag of the card used"; readonly example: "VISA"; readonly deprecated: false; readonly enum: readonly ["VISA", "MASTERCARD", "ELO", "DINERS", "DISCOVER", "AMEX", "HIPERCARD", "CABAL", "BANESCARD", "CREDZ", "SOROCRED", "CREDSYSTEM", "JCB", "UNKNOWN"]; }; export declare const ApiPaymentChargebackResponseChargebackDisputeStatusSchema: { readonly type: "string"; readonly description: "Chargeback dispute status."; readonly example: "ACCEPTED"; readonly deprecated: false; readonly enum: readonly ["REQUESTED", "ACCEPTED", "REJECTED"]; }; export declare const ApiChargebackListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentChargebackResponseDTO"; }; }; }; }; export declare const ApiChargebackListRequestCreditCardBrandSchema: { readonly type: "string"; readonly description: "Filter by used card brand."; readonly example: "VISA"; readonly deprecated: false; readonly enum: readonly ["VISA", "MASTERCARD", "ELO", "DINERS", "DISCOVER", "AMEX", "HIPERCARD", "CABAL", "BANESCARD", "CREDZ", "SOROCRED", "CREDSYSTEM", "JCB", "UNKNOWN"]; }; export declare const ApiChargebackListRequestChargebackStatusSchema: { readonly type: "string"; readonly description: "Filter by chargeback status."; readonly example: "REQUESTED"; readonly deprecated: false; readonly enum: readonly ["REQUESTED", "IN_DISPUTE", "DISPUTE_LOST", "REVERSED", "DONE"]; }; export declare const ApiCreditBureauReportGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique report identifier in Asaas"; readonly example: "6c5e73fa-9efd-4a75-b60c-1cafb8d1c7ed"; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Date of consultation"; readonly format: "date"; readonly example: "17/01/2025"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ consulted manually"; readonly example: "05666663755"; readonly deprecated: false; }; readonly state: { readonly $ref: "#/components/schemas/ApiCreditBureauReportGetResponseState"; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_000000001766"; readonly deprecated: false; }; readonly downloadUrl: { readonly type: "string"; readonly description: "Url to download the report. Available until 11:59 pm on the day of the appointment."; readonly example: "https://www.asaas.com.br/creditBureauReport/download/6c5e73fa-9efd-4a75-b60c-1cafb8d1c7ed"; readonly deprecated: false; }; readonly reportFile: { readonly type: "string"; readonly description: "PDF of the query report in Base64 (this field is only returned when the report is created)"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiCreditBureauReportGetResponseStateSchema: { readonly type: "string"; readonly description: "UF of the state in which the consultation was made"; readonly example: "SC"; readonly deprecated: true; readonly enum: readonly ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RR", "RO", "RJ", "RN", "RS", "SC", "SP", "SE", "TO"]; }; export declare const ApiCreditBureauReportSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly deprecated: false; readonly example: null; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the customer. Enter this field if your client is not registered with Asaas"; readonly example: "05666663755"; readonly deprecated: false; }; readonly state: { readonly $ref: "#/components/schemas/ApiCreditBureauReportSaveRequestState"; }; }; }; export declare const ApiCreditBureauReportSaveRequestStateSchema: { readonly type: "string"; readonly description: "State in which you want to carry out the consultation"; readonly example: "AC"; readonly deprecated: true; readonly enum: readonly ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RR", "RO", "RJ", "RN", "RS", "SC", "SP", "SE", "TO"]; }; export declare const ApiCreditBureauReportListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiCreditBureauReportGetResponseDTO"; }; }; }; }; export declare const ApiCreditCardTokenizeRequestDTOSchema: { readonly required: readonly ["customer", "creditCard", "creditCardHolderInfo", "remoteIp"]; readonly type: "object"; readonly properties: { readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiCreditCardRequestDTO"; }; readonly creditCardHolderInfo: { readonly $ref: "#/components/schemas/ApiCreditCardHolderInfoRequestDTO"; }; readonly remoteIp: { readonly required: readonly ["remoteIp"]; readonly type: "string"; readonly description: "IP from where the customer is making the purchase. Your server's IP must not be entered."; readonly example: "116.213.42.532"; readonly deprecated: false; }; }; }; export declare const ApiCreditCardRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly holderName: { readonly required: readonly ["holderName"]; readonly type: "string"; readonly description: "Name printed on card"; readonly example: "John Doe"; readonly deprecated: false; }; readonly number: { readonly required: readonly ["number"]; readonly type: "string"; readonly description: "Card number"; readonly example: "1234567890123456"; readonly deprecated: false; }; readonly expiryMonth: { readonly required: readonly ["expiryMonth"]; readonly type: "string"; readonly description: "Expiration month with 2 digits"; readonly example: "1"; readonly deprecated: false; }; readonly expiryYear: { readonly required: readonly ["expiryYear"]; readonly type: "string"; readonly description: "Expiration year with 4 digits"; readonly example: "2025"; readonly deprecated: false; }; readonly ccv: { readonly required: readonly ["ccv"]; readonly type: "string"; readonly description: "Security code"; readonly example: "123"; readonly deprecated: false; }; }; readonly description: "Credit card information"; readonly deprecated: false; }; export declare const ApiCreditCardHolderInfoRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly required: readonly ["name"]; readonly type: "string"; readonly description: "Name of card holder"; readonly example: "John Doe"; readonly deprecated: false; }; readonly email: { readonly required: readonly ["email"]; readonly type: "string"; readonly description: "Cardholder email"; readonly example: "john.doe@asaas.com"; readonly deprecated: false; }; readonly cpfCnpj: { readonly required: readonly ["cpfCnpj"]; readonly type: "string"; readonly description: "CPF or CNPJ of the cardholder"; readonly example: "12345678901"; readonly deprecated: false; }; readonly postalCode: { readonly required: readonly ["postalCode"]; readonly type: "string"; readonly description: "Cardholder zip code"; readonly example: "12345678"; readonly deprecated: false; }; readonly addressNumber: { readonly required: readonly ["addressNumber"]; readonly type: "string"; readonly description: "Cardholder address number"; readonly example: "123"; readonly deprecated: false; }; readonly addressComplement: { readonly type: "string"; readonly description: "Supplementing the cardholder's address"; readonly deprecated: false; readonly example: null; }; readonly phone: { readonly required: readonly ["phone"]; readonly type: "string"; readonly description: "Phone with cardholder's area code"; readonly deprecated: false; readonly example: null; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Cardholder's cell phone"; readonly deprecated: false; readonly example: null; }; }; readonly description: "Credit card holder information"; readonly deprecated: false; }; export declare const ApiCreditCardTokenizeResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly creditCardNumber: { readonly type: "string"; readonly description: "Last 4 digits of the card used"; readonly example: "8829"; readonly deprecated: false; }; readonly creditCardBrand: { readonly $ref: "#/components/schemas/ApiCreditCardTokenizeResponseCreditCardBrand"; }; readonly creditCardToken: { readonly type: "string"; readonly description: "Credit card token that can be sent in future transactions without the need to re-enter card and cardholder details."; readonly example: "a75a1d98-c52d-4a6b-a413-71e00b193c99"; readonly deprecated: false; }; }; }; export declare const ApiCreditCardTokenizeResponseCreditCardBrandSchema: { readonly type: "string"; readonly description: "Brand of the card used"; readonly example: "VISA"; readonly deprecated: false; readonly enum: readonly ["VISA", "MASTERCARD", "ELO", "DINERS", "DISCOVER", "AMEX", "HIPERCARD", "CABAL", "BANESCARD", "CREDZ", "SOROCRED", "CREDSYSTEM", "JCB", "UNKNOWN"]; }; export declare const ApiCustomerAccountRestoreRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiCustomerAccountGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "customer"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000005401844"; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Customer creation date"; readonly example: "2024-07-12"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Client name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Customer email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly phone: { readonly type: "string"; readonly description: "Customer phone"; readonly example: "90999999999"; readonly deprecated: false; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Customer cell phone"; readonly example: "90999999999"; readonly deprecated: false; }; readonly address: { readonly type: "string"; readonly description: "Customer address"; readonly example: "Av. Paulista"; readonly deprecated: false; }; readonly addressNumber: { readonly type: "string"; readonly description: "Customer address number"; readonly example: "150"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Customer address complement"; readonly example: "Sala 201"; readonly deprecated: false; }; readonly province: { readonly type: "string"; readonly description: "Customer address neighborhood"; readonly example: "Centro"; readonly deprecated: false; }; readonly city: { readonly type: "string"; readonly description: "Unique city identifier in Asaas"; readonly example: "12565"; readonly deprecated: false; }; readonly cityName: { readonly type: "string"; readonly description: "City of customer address"; readonly example: "São Paulo"; readonly deprecated: false; }; readonly state: { readonly type: "string"; readonly description: "Customer address status"; readonly example: "SP"; readonly deprecated: false; }; readonly country: { readonly type: "string"; readonly description: "Customer country"; readonly example: "Brasil"; readonly deprecated: false; }; readonly postalCode: { readonly type: "string"; readonly description: "Customer address zip code"; readonly example: "01310000"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "Customer CPF or CNPJ"; readonly example: "24971563792"; readonly deprecated: false; }; readonly personType: { readonly $ref: "#/components/schemas/ApiCustomerAccountGetResponsePersonType"; }; readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether it is a deleted client"; readonly example: false; readonly deprecated: false; }; readonly additionalEmails: { readonly type: "string"; readonly description: "Additional customer emails"; readonly example: "john.doe@asaas.com,john.doe.silva@asaas.com.br"; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "External customer reference"; readonly example: "12987382"; readonly deprecated: false; }; readonly notificationDisabled: { readonly type: "boolean"; readonly description: "Indicates whether notifications are disabled"; readonly example: false; readonly deprecated: false; }; readonly observations: { readonly type: "string"; readonly description: "Customer Observations"; readonly example: "great payer, no problems so far"; readonly deprecated: false; }; readonly foreignCustomer: { readonly type: "boolean"; readonly description: "Indicates if it's non-brazilian customer"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiCustomerAccountGetResponsePersonTypeSchema: { readonly type: "string"; readonly description: "Kind of person"; readonly example: "FISICA"; readonly deprecated: false; readonly enum: readonly ["JURIDICA", "FISICA"]; }; export declare const ApiCustomerAccountSaveRequestDTOSchema: { readonly required: readonly ["name", "cpfCnpj"]; readonly type: "object"; readonly properties: { readonly name: { readonly required: readonly ["name"]; readonly type: "string"; readonly description: "Client name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly cpfCnpj: { readonly required: readonly ["cpfCnpj"]; readonly type: "string"; readonly description: "Customer CPF or CNPJ"; readonly example: "24971563792"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Customer email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly phone: { readonly type: "string"; readonly description: "Landline"; readonly example: "4738010919"; readonly deprecated: false; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Cell phone"; readonly example: "4799376637"; readonly deprecated: false; }; readonly address: { readonly type: "string"; readonly description: "Public place"; readonly example: "Av. Paulista"; readonly deprecated: false; }; readonly addressNumber: { readonly type: "string"; readonly description: "Address number"; readonly example: "150"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Address complement (max. 255 characters)"; readonly example: "Sala 201"; readonly deprecated: false; }; readonly province: { readonly type: "string"; readonly description: "Neighborhood"; readonly example: "Centro"; readonly deprecated: false; }; readonly postalCode: { readonly type: "string"; readonly description: "Address zip code"; readonly example: "01310-000"; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Customer identifier in your system"; readonly example: "12987382"; readonly deprecated: false; }; readonly notificationDisabled: { readonly type: "boolean"; readonly description: "true to disable sending billing notifications"; readonly example: false; readonly deprecated: false; }; readonly additionalEmails: { readonly type: "string"; readonly description: "Additional emails for sending billing notifications separated by \",\""; readonly example: "john.doe@asaas.com,john.doe.silva@asaas.com.br"; readonly deprecated: false; }; readonly municipalInscription: { readonly type: "string"; readonly description: "Customer municipal registration"; readonly example: "46683695908"; readonly deprecated: false; }; readonly stateInscription: { readonly type: "string"; readonly description: "Customer state registration"; readonly example: "646681195275"; readonly deprecated: false; }; readonly observations: { readonly type: "string"; readonly description: "Additional observations"; readonly example: "great payer, no problems so far"; readonly deprecated: false; }; readonly groupName: { readonly type: "string"; readonly description: "Name of the group the customer belongs to"; readonly deprecated: false; readonly example: null; }; readonly company: { readonly type: "string"; readonly description: "Company"; readonly deprecated: false; readonly example: null; }; readonly foreignCustomer: { readonly type: "boolean"; readonly description: "inform true if it's a non-brazilian customer"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiCustomerAccountUpdateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Client name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "Customer CPF or CNPJ"; readonly example: "24971563792"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Customer email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly phone: { readonly type: "string"; readonly description: "Landline"; readonly example: "4738010919"; readonly deprecated: false; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Cell phone"; readonly example: "4799376637"; readonly deprecated: false; }; readonly address: { readonly type: "string"; readonly description: "Public place"; readonly example: "Av. Paulista"; readonly deprecated: false; }; readonly addressNumber: { readonly type: "string"; readonly description: "Address number"; readonly example: "150"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Address complement"; readonly example: "Sala 201"; readonly deprecated: false; }; readonly province: { readonly type: "string"; readonly description: "Neighborhood"; readonly example: "Centro"; readonly deprecated: false; }; readonly postalCode: { readonly type: "string"; readonly description: "Address zip code"; readonly example: "01310-000"; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Customer identifier in your system"; readonly example: "12987382"; readonly deprecated: false; }; readonly notificationDisabled: { readonly type: "boolean"; readonly description: "true to disable sending billing notifications"; readonly example: false; readonly deprecated: false; }; readonly additionalEmails: { readonly type: "string"; readonly description: "Additional emails for sending billing notifications separated by \",\""; readonly example: "john.doe@asaas.com,john.doe.silva@asaas.com.br"; readonly deprecated: false; }; readonly municipalInscription: { readonly type: "string"; readonly description: "Customer municipal registration"; readonly example: "46683695908"; readonly deprecated: false; }; readonly stateInscription: { readonly type: "string"; readonly description: "Customer state registration"; readonly example: "646681195275"; readonly deprecated: false; }; readonly observations: { readonly type: "string"; readonly description: "Additional observations"; readonly example: "great payer, no problems so far"; readonly deprecated: false; }; readonly groupName: { readonly type: "string"; readonly description: "Name of the group the customer belongs to"; readonly deprecated: false; readonly example: null; }; readonly company: { readonly type: "string"; readonly description: "Company"; readonly deprecated: false; readonly example: null; }; readonly foreignCustomer: { readonly type: "boolean"; readonly description: "inform true if it's a non-brazilian customer"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiCustomerAccountListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiCustomerAccountGetResponseDTO"; }; }; }; }; export declare const ApiCustomerAccountDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the client has been removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000005401844"; readonly deprecated: false; }; }; }; export declare const ApiCustomerGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "account"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique subaccount identifier in Asaas"; readonly example: "4f468235-cec3-482f-b3d0-348af4c7194"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Subaccount name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Subaccount email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly loginEmail: { readonly type: "string"; readonly description: "Email for subaccount login, if not provided, the subaccount email will be used"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly phone: { readonly type: "string"; readonly description: "Telephone"; readonly deprecated: false; readonly example: null; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Cellphone"; readonly deprecated: false; readonly example: null; }; readonly address: { readonly type: "string"; readonly description: "Public place"; readonly example: "Rua Fernando Orlandi"; readonly deprecated: false; }; readonly addressNumber: { readonly type: "string"; readonly description: "Address number"; readonly example: "544"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Address complement"; readonly deprecated: false; readonly example: null; }; readonly province: { readonly type: "string"; readonly description: "Neighborhood"; readonly example: "Jardim Pedra Branca"; readonly deprecated: false; }; readonly postalCode: { readonly type: "string"; readonly description: "Address zip code"; readonly example: "14079-452"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the subaccount owner"; readonly example: "35381637000150"; readonly deprecated: false; }; readonly birthDate: { readonly type: "string"; readonly description: "Date of birth (only for Individuals)"; readonly format: "date"; readonly example: "1995-04-12"; readonly deprecated: false; }; readonly personType: { readonly $ref: "#/components/schemas/ApiCustomerGetResponsePersonType"; }; readonly companyType: { readonly $ref: "#/components/schemas/ApiCustomerGetResponseCompanyType"; }; readonly city: { readonly type: "integer"; readonly description: "Unique city identifier in Asaas"; readonly format: "int32"; readonly example: 15478; readonly deprecated: false; }; readonly state: { readonly type: "string"; readonly description: "State abbreviation (SP, RJ, SC, ...)"; readonly example: "SP"; readonly deprecated: false; }; readonly country: { readonly type: "string"; readonly description: "Country (Fixed Brazil)"; readonly example: "Brasil"; readonly deprecated: false; }; readonly tradingName: { readonly type: "string"; readonly description: "Display name (auto-populated)"; readonly deprecated: false; readonly example: null; }; readonly site: { readonly type: "string"; readonly description: "Url reffered to the subaccount"; readonly example: "https://www.dominio.com"; readonly deprecated: false; }; readonly walletId: { readonly type: "string"; readonly description: "Unique wallet identifier to split charges or transfer between Asaas accounts"; readonly example: "c0c1688f-636b-42c0-b6ee-7339182276b7"; readonly deprecated: false; }; readonly accountNumber: { readonly $ref: "#/components/schemas/ApiCustomerAccountNumberDTO"; }; readonly commercialInfoExpiration: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestCommercialInfoExpirationResponseDTO"; }; }; }; export declare const ApiCustomerGetResponsePersonTypeSchema: { readonly type: "string"; readonly description: "Kind of person"; readonly example: "JURIDICA"; readonly deprecated: false; readonly enum: readonly ["JURIDICA", "FISICA"]; }; export declare const ApiCustomerGetResponseCompanyTypeSchema: { readonly type: "string"; readonly description: "Type of company (only when Legal Entity)"; readonly example: "MEI"; readonly deprecated: false; readonly enum: readonly ["MEI", "LIMITED", "INDIVIDUAL", "ASSOCIATION"]; }; export declare const ApiCustomerAccountNumberDTOSchema: { readonly type: "object"; readonly properties: { readonly agency: { readonly type: "string"; readonly description: "Account agency"; readonly example: "0001"; readonly deprecated: false; }; readonly account: { readonly type: "string"; readonly description: "Account number"; readonly example: "3514"; readonly deprecated: false; }; readonly accountDigit: { readonly type: "string"; readonly description: "Account digit"; readonly example: "3"; readonly deprecated: false; }; }; readonly description: "Subaccount number in Asaas"; readonly deprecated: false; }; export declare const ApiCustomerUpdateRequestCommercialInfoExpirationResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly isExpired: { readonly type: "boolean"; readonly description: "Informs if commercial data is expired"; readonly example: false; readonly deprecated: false; }; readonly scheduledDate: { readonly type: "string"; readonly description: "Informs the expiration date of commercial data"; readonly format: "date-time"; readonly example: "2025-05-05 00:00:00"; readonly deprecated: false; }; }; readonly description: "Information about the expiration of commercial data"; readonly deprecated: false; }; export declare const ApiCustomerSaveRequestDTOSchema: { readonly required: readonly ["name", "email", "cpfCnpj", "mobilePhone", "incomeValue", "address", "addressNumber", "province", "postalCode"]; readonly type: "object"; readonly properties: { readonly name: { readonly required: readonly ["name"]; readonly type: "string"; readonly description: "Subaccount name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly email: { readonly required: readonly ["email"]; readonly type: "string"; readonly description: "Subaccount email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly loginEmail: { readonly type: "string"; readonly description: "Email for subaccount login, if not provided, the subaccount email will be used"; readonly example: "johndoe@asaas.com.br"; readonly deprecated: false; }; readonly cpfCnpj: { readonly required: readonly ["cpfCnpj"]; readonly type: "string"; readonly description: "CPF or CNPJ of the subaccount owner"; readonly example: "35381637000150"; readonly deprecated: false; }; readonly birthDate: { readonly type: "string"; readonly description: "Date of birth (only for Individuals)"; readonly format: "date"; readonly example: "1995-04-12"; readonly deprecated: false; }; readonly companyType: { readonly $ref: "#/components/schemas/ApiCustomerSaveRequestCompanyType"; }; readonly phone: { readonly type: "string"; readonly description: "Telephone"; readonly deprecated: false; readonly example: null; }; readonly mobilePhone: { readonly required: readonly ["mobilePhone"]; readonly type: "string"; readonly description: "Cellphone"; readonly deprecated: false; readonly example: null; }; readonly site: { readonly type: "string"; readonly description: "Url reffered to the subaccount"; readonly example: "https://www.dominio.com"; readonly deprecated: false; }; readonly incomeValue: { readonly required: readonly ["incomeValue"]; readonly type: "number"; readonly description: "Billing/Monthly income"; readonly example: 25000; readonly deprecated: false; }; readonly address: { readonly required: readonly ["address"]; readonly type: "string"; readonly description: "Public place"; readonly example: "Rua Fernando Orlandi"; readonly deprecated: false; }; readonly addressNumber: { readonly required: readonly ["addressNumber"]; readonly type: "string"; readonly description: "Address number"; readonly example: "544"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Address complement"; readonly deprecated: false; readonly example: null; }; readonly province: { readonly required: readonly ["province"]; readonly type: "string"; readonly description: "Neighborhood"; readonly example: "Jardim Pedra Branca"; readonly deprecated: false; }; readonly postalCode: { readonly required: readonly ["postalCode"]; readonly type: "string"; readonly description: "Address zip code"; readonly example: "14079-452"; readonly deprecated: false; }; readonly webhooks: { readonly type: "array"; readonly description: "Array with desired Webhooks settings"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Webhook name"; readonly example: "Name Example"; readonly deprecated: false; }; readonly url: { readonly type: "string"; readonly description: "Webhook URL"; readonly example: "https://www.exemplo.com/webhook/asaas"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Email that will receive notifications about the Webhook"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Set whether the Webhook is active"; readonly example: true; readonly deprecated: false; }; readonly interrupted: { readonly type: "boolean"; readonly description: "Set whether the sync queue is stopped"; readonly example: false; readonly deprecated: false; }; readonly apiVersion: { readonly type: "integer"; readonly description: "API Version"; readonly format: "int32"; readonly example: 3; readonly deprecated: false; }; readonly authToken: { readonly type: "string"; readonly description: "Webhook authentication token"; readonly example: "5tLxsL6uoN"; readonly deprecated: false; }; readonly sendType: { readonly $ref: "#/components/schemas/ApiPushNotificationConfigSaveRequestPushNotificationSendType"; }; readonly events: { readonly type: "array"; readonly description: "List of events this Webhook will observe"; readonly example: readonly ["PAYMENT_RECEIVED", "PAYMENT_CONFIRMED"]; readonly deprecated: false; readonly items: { readonly type: "string"; }; }; }; }; }; }; }; export declare const ApiCustomerSaveRequestCompanyTypeSchema: { readonly type: "string"; readonly description: "Type of company (only when Legal Entity)"; readonly example: "MEI"; readonly deprecated: false; readonly enum: readonly ["MEI", "LIMITED", "INDIVIDUAL", "ASSOCIATION"]; }; export declare const ApiPushNotificationConfigSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Webhook name"; readonly example: "Name Example"; readonly deprecated: false; }; readonly url: { readonly type: "string"; readonly description: "Webhook URL"; readonly example: "https://www.exemplo.com/webhook/asaas"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Email that will receive notifications about the Webhook"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Set whether the Webhook is active"; readonly example: true; readonly deprecated: false; }; readonly interrupted: { readonly type: "boolean"; readonly description: "Set whether the sync queue is stopped"; readonly example: false; readonly deprecated: false; }; readonly apiVersion: { readonly type: "integer"; readonly description: "API Version"; readonly format: "int32"; readonly example: 3; readonly deprecated: false; }; readonly authToken: { readonly type: "string"; readonly description: "Webhook authentication token"; readonly example: "5tLxsL6uoN"; readonly deprecated: false; }; readonly sendType: { readonly $ref: "#/components/schemas/ApiPushNotificationConfigSaveRequestPushNotificationSendType"; }; readonly events: { readonly type: "array"; readonly description: "List of events this Webhook will observe"; readonly example: readonly ["PAYMENT_RECEIVED", "PAYMENT_CONFIRMED"]; readonly deprecated: false; readonly items: { readonly type: "string"; }; }; }; }; export declare const ApiPushNotificationConfigSaveRequestPushNotificationSendTypeSchema: { readonly type: "string"; readonly description: "Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)"; readonly example: "SEQUENTIALLY"; readonly deprecated: false; readonly enum: readonly ["NON_SEQUENTIALLY", "SEQUENTIALLY"]; }; export declare const ApiPushNotificationConfigSaveRequestPushNotificationRequestEventSchema: { readonly type: "string"; }; export declare const ApiCustomerSaveResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "account"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique subaccount identifier in Asaas"; readonly example: "4f468235-cec3-482f-b3d0-348af4c7194"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Subaccount name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Subaccount email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly loginEmail: { readonly type: "string"; readonly description: "Email for subaccount login, if not provided, the subaccount email will be used"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly phone: { readonly type: "string"; readonly description: "Telephone"; readonly deprecated: false; readonly example: null; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Cellphone"; readonly deprecated: false; readonly example: null; }; readonly address: { readonly type: "string"; readonly description: "Public place"; readonly example: "Rua Fernando Orlandi"; readonly deprecated: false; }; readonly addressNumber: { readonly type: "string"; readonly description: "Address number"; readonly example: "544"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Address complement"; readonly deprecated: false; readonly example: null; }; readonly province: { readonly type: "string"; readonly description: "Neighborhood"; readonly example: "Jardim Pedra Branca"; readonly deprecated: false; }; readonly postalCode: { readonly type: "string"; readonly description: "Address zip code"; readonly example: "14079-452"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the subaccount owner"; readonly example: "35381637000150"; readonly deprecated: false; }; readonly birthDate: { readonly type: "string"; readonly description: "Date of birth (only for Individuals)"; readonly format: "date"; readonly example: "1995-04-12"; readonly deprecated: false; }; readonly personType: { readonly $ref: "#/components/schemas/ApiCustomerSaveResponsePersonType"; }; readonly companyType: { readonly $ref: "#/components/schemas/ApiCustomerSaveResponseCompanyType"; }; readonly city: { readonly type: "integer"; readonly description: "Unique city identifier in Asaas"; readonly format: "int32"; readonly example: 15478; readonly deprecated: false; }; readonly state: { readonly type: "string"; readonly description: "State abbreviation (SP, RJ, SC, ...)"; readonly example: "SP"; readonly deprecated: false; }; readonly country: { readonly type: "string"; readonly description: "Country (Fixed Brazil)"; readonly example: "Brasil"; readonly deprecated: false; }; readonly tradingName: { readonly type: "string"; readonly description: "Display name (auto-populated)"; readonly deprecated: false; readonly example: null; }; readonly site: { readonly type: "string"; readonly description: "Url reffered to the subaccount"; readonly example: "https://www.dominio.com"; readonly deprecated: false; }; readonly walletId: { readonly type: "string"; readonly description: "Unique wallet identifier to split charges or transfer between Asaas accounts"; readonly example: "c0c1688f-636b-42c0-b6ee-7339182276b7"; readonly deprecated: false; }; readonly accountNumber: { readonly $ref: "#/components/schemas/ApiCustomerAccountNumberDTO"; }; readonly commercialInfoExpiration: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestCommercialInfoExpirationResponseDTO"; }; readonly apiKey: { readonly type: "string"; readonly description: "API key"; readonly example: "3d425760b01ea73feab3357de2a50c42fc8bc055861f4631e3be906700210874"; readonly deprecated: false; }; }; }; export declare const ApiCustomerSaveResponsePersonTypeSchema: { readonly type: "string"; readonly description: "Kind of person"; readonly example: "JURIDICA"; readonly deprecated: false; readonly enum: readonly ["JURIDICA", "FISICA"]; }; export declare const ApiCustomerSaveResponseCompanyTypeSchema: { readonly type: "string"; readonly description: "Type of company (only when Legal Entity)"; readonly example: "MEI"; readonly deprecated: false; readonly enum: readonly ["MEI", "LIMITED", "INDIVIDUAL", "ASSOCIATION"]; }; export declare const ApiCustomerListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiCustomerGetResponseDTO"; }; }; }; }; export declare const ApiCustomerFiscalInfoUpdateUseNationalPortalRequestDTOSchema: { readonly required: readonly ["enabled"]; readonly type: "object"; readonly properties: { readonly enabled: { readonly required: readonly ["enabled"]; readonly type: "boolean"; readonly description: "Indicates whether the issuing of invoices through the national portal should be enabled or not."; readonly example: true; readonly deprecated: false; }; }; }; export declare const ApiCustomerFiscalInfoUpdateUseNationalPortalResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly success: { readonly type: "boolean"; readonly description: "Status of the request to change the use status of national portal for issuing invoices."; readonly example: true; readonly deprecated: false; }; }; }; export declare const ApiCustomerFiscalInfoListMunicipalServicesResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly example: readonly [{ readonly id: "3544"; readonly description: "1.01 - Análise e desenvolvimento de sistemas"; readonly issTax: 5; }, { readonly id: "2360"; readonly description: "1.02 - Programação"; readonly issTax: 3; }]; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique service identifier"; readonly example: "3544"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Service description"; readonly example: "1.01 - Análise e desenvolvimento de sistemas"; readonly deprecated: false; }; readonly issTax: { readonly type: "number"; readonly description: "ISS percentage rate"; readonly example: 0.5; readonly deprecated: false; }; }; }; }; }; }; export declare const ApiCustomerFiscalInfoListMunicipalServicesResponseDataDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique service identifier"; readonly example: "3544"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Service description"; readonly example: "1.01 - Análise e desenvolvimento de sistemas"; readonly deprecated: false; }; readonly issTax: { readonly type: "number"; readonly description: "ISS percentage rate"; readonly example: 0.5; readonly deprecated: false; }; }; }; export declare const ApiCustomerFiscalInfoMunicipalOptionsGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly authenticationType: { readonly $ref: "#/components/schemas/ApiCustomerFiscalInfoMunicipalOptionsGetResponseEnotasTipoAutenticacao"; }; readonly supportsCancellation: { readonly type: "boolean"; readonly description: "Whether or not it supports the cancellation of invoices automatically at your city hall"; readonly example: true; readonly deprecated: false; readonly default: true; }; readonly usesSpecialTaxRegimes: { readonly type: "boolean"; readonly description: "It is necessary to inform or not the special taxation regime. If used, enter it in the `specialTaxRegime` field of **Create or update tax information** according to the options returned in the `specialTaxRegimesList` list."; readonly example: true; readonly deprecated: false; readonly default: true; }; readonly usesServiceListItem: { readonly type: "boolean"; readonly description: "Whether or not to inform the item on the service list"; readonly example: true; readonly deprecated: false; readonly default: true; }; readonly specialTaxRegimesList: { readonly type: "array"; readonly description: "Tax calculation regime options"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly label: { readonly type: "string"; readonly description: "Name of the special taxation regime"; readonly example: "Municipal Micro enterprise"; readonly deprecated: false; }; readonly value: { readonly type: "string"; readonly description: "Special taxation regime identifier"; readonly example: "1"; readonly deprecated: false; }; }; }; }; readonly nationalPortalTaxCalculationRegimeList: { readonly type: "array"; readonly description: "Special taxation regime options"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly label: { readonly type: "string"; readonly description: "Name of the tax calculation regime"; readonly example: "Regime for calculating federal and municipal taxes by the SN"; readonly deprecated: false; }; readonly value: { readonly type: "string"; readonly description: "Identifier of the tax calculation regime"; readonly example: "0"; readonly deprecated: false; }; }; }; }; readonly nationalPortalTaxCalculationRegimeHelp: { readonly type: "string"; readonly description: "Explanation of the tax calculation regime"; readonly example: "This identifies your company's tax calculation regime. If you wish to leave no option selected, select the \"None\" option. It must only be completed by companies classified as ME or EPP opting for Simples Nacional. Consult the need for this information with your city hall or accounting department."; readonly deprecated: false; }; readonly municipalInscriptionHelp: { readonly type: "string"; readonly description: "Explanation of the municipal registration format"; readonly example: "Only enter numbers without periods or formatting (if they contain letters, always enter them in capital letters).\n\nValid examples: 4301000010 or 131436001X"; readonly deprecated: false; }; readonly specialTaxRegimeHelp: { readonly type: "string"; readonly description: "Explanation of the special taxation regime"; readonly example: "This identifies your company's taxation regime, if you wish to leave no option marked, select the dash (\"-\").\n \n Simple national companies generally opt for ME or ME EPP"; readonly deprecated: false; }; readonly serviceListItemHelp: { readonly type: "string"; readonly description: "Explanation of service list item format"; readonly example: "Enter the service list item here, it is also an identifier of the service provided.\n \n You need to complete the service list item maintaining the formatting.\n Valid examples: 17.02 or 8.02"; readonly deprecated: false; }; readonly digitalCertificatedHelp: { readonly type: "string"; readonly description: "Explanation of digital certificate"; readonly example: "Your city hall requires the use of a digital certificate, so include your A1 certificate file here."; readonly deprecated: false; }; readonly accessTokenHelp: { readonly type: "string"; readonly description: "Token Explanation"; readonly deprecated: false; readonly example: null; }; readonly municipalServiceCodeHelp: { readonly type: "string"; readonly description: "Explanation of municipal service code format"; readonly example: "Enter here the municipal code that identifies the service provided on the invoice.\nIn some cities this code is known as the taxation code or CTISS.\n\nValid example: 010300388"; readonly deprecated: false; }; }; }; export declare const ApiCustomerFiscalInfoMunicipalOptionsGetResponseEnotasTipoAutenticacaoSchema: { readonly type: "string"; readonly description: "Type of authentication required at city hall"; readonly example: "CERTIFICATE"; readonly deprecated: false; readonly enum: readonly ["CERTIFICATE", "TOKEN", "USER_AND_PASSWORD"]; }; export declare const ApiCustomerFiscalInfoMunicipalOptionsSpecialTaxRegimesDTOSchema: { readonly type: "object"; readonly properties: { readonly label: { readonly type: "string"; readonly description: "Name of the special taxation regime"; readonly example: "Municipal Micro enterprise"; readonly deprecated: false; }; readonly value: { readonly type: "string"; readonly description: "Special taxation regime identifier"; readonly example: "1"; readonly deprecated: false; }; }; }; export declare const ApiCustomerFiscalInfoMunicipalOptionsNationalPortalTaxCalculationRegimeDTOSchema: { readonly type: "object"; readonly properties: { readonly label: { readonly type: "string"; readonly description: "Name of the tax calculation regime"; readonly example: "Regime for calculating federal and municipal taxes by the SN"; readonly deprecated: false; }; readonly value: { readonly type: "string"; readonly description: "Identifier of the tax calculation regime"; readonly example: "0"; readonly deprecated: false; }; }; }; export declare const ApiCustomerFiscalInfoGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "customerFiscalInfo"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Email used by Asaas to send invoice notifications and alerts"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly municipalInscription: { readonly type: "string"; readonly description: "Company municipal registration"; readonly example: "21779501"; readonly deprecated: false; }; readonly simplesNacional: { readonly type: "boolean"; readonly description: "Indicates whether the company opts for the simple national system"; readonly example: false; readonly deprecated: false; readonly default: true; }; readonly culturalProjectsPromoter: { readonly type: "boolean"; readonly description: "Identifies whether the company is classified as a cultural promoter"; readonly example: false; readonly deprecated: false; readonly default: true; }; readonly cnae: { readonly type: "string"; readonly description: "CNAE code"; readonly example: "6209100"; readonly deprecated: false; }; readonly specialTaxRegime: { readonly type: "string"; readonly description: "Special taxation regime identifier"; readonly example: "1"; readonly deprecated: false; }; readonly serviceListItem: { readonly type: "string"; readonly description: "Service list item, as http://www.planalto.gov.br/ccivil_03/leis/LCP/Lcp116.htm"; readonly deprecated: false; readonly example: null; }; readonly rpsSerie: { readonly type: "string"; readonly description: "Serial Number registered for the company"; readonly example: "1"; readonly deprecated: false; }; readonly rpsNumber: { readonly type: "integer"; readonly description: "RPS number used in the last invoice issued to your company"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly loteNumber: { readonly type: "integer"; readonly description: "Batch number used on the last invoice issued by your company"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly username: { readonly type: "string"; readonly description: "User to access your city's city hall website"; readonly example: "johndoe"; readonly deprecated: false; }; readonly passwordSent: { readonly type: "boolean"; readonly description: "Indicates whether the password to access the city hall website has been entered"; readonly example: true; readonly deprecated: false; readonly default: true; }; readonly accessTokenSent: { readonly type: "boolean"; readonly description: "Indicates whether the token for accessing the city hall website was provided"; readonly example: true; readonly deprecated: false; readonly default: true; }; readonly certificateSent: { readonly type: "boolean"; readonly description: "Indicates whether the digital certificate for access to the city hall website has been provided"; readonly example: true; readonly deprecated: false; readonly default: true; }; readonly nationalPortalTaxCalculationRegime: { readonly type: "string"; readonly description: "Identifier of the tax calculation regime"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiCustomerFiscalInfoSaveRequestDTOSchema: { readonly required: readonly ["email", "simplesNacional"]; readonly type: "object"; readonly properties: { readonly email: { readonly required: readonly ["email"]; readonly type: "string"; readonly description: "Email used by Asaas to send invoice notifications and alerts"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly municipalInscription: { readonly type: "string"; readonly description: "Company municipal registration"; readonly example: "21779501"; readonly deprecated: false; }; readonly simplesNacional: { readonly required: readonly ["simplesNacional"]; readonly type: "boolean"; readonly description: "Indicates whether the company opts for the simple national system"; readonly example: false; readonly deprecated: false; readonly default: true; }; readonly culturalProjectsPromoter: { readonly type: "boolean"; readonly description: "Identifies whether the company is classified as a cultural promoter"; readonly example: false; readonly deprecated: false; readonly default: true; }; readonly cnae: { readonly type: "string"; readonly description: "CNAE code"; readonly example: "6209100"; readonly deprecated: false; }; readonly specialTaxRegime: { readonly type: "string"; readonly description: "Special taxation regime identifier"; readonly example: "1"; readonly deprecated: false; }; readonly serviceListItem: { readonly type: "string"; readonly description: "Service list item, as http://www.planalto.gov.br/ccivil_03/leis/LCP/Lcp116.htm"; readonly deprecated: false; readonly example: null; }; readonly rpsSerie: { readonly type: "string"; readonly description: "Serial Number used by your company to issue invoices. In most cities the serial number used is '1' or 'E'"; readonly example: "1"; readonly deprecated: false; }; readonly rpsNumber: { readonly type: "integer"; readonly description: "RPS number used on the last invoice issued by your company. If your last NF issued has an RPS equal to '100', this field must be filled in with '101'. If you have never issued invoices through your city hall's website, enter '1' in this field"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly loteNumber: { readonly type: "integer"; readonly description: "Batch number used on the last invoice issued by your company. If the last lot used in your city hall is '25', this field must be filled in with '26'. Only enter this field if your city hall requires the use of lots"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly username: { readonly type: "string"; readonly description: "User to access your city's city hall website"; readonly example: "johndoe"; readonly deprecated: false; }; readonly password: { readonly type: "string"; readonly description: "Password to access the city hall website"; readonly deprecated: false; readonly example: null; }; readonly accessToken: { readonly type: "string"; readonly description: "Token for access to the city hall website (If access to your city hall website is via Token)"; readonly deprecated: false; readonly example: null; }; readonly certificateFile: { readonly $ref: "#/components/schemas/File"; }; readonly certificatePassword: { readonly type: "string"; readonly description: "Password for the digital certificate sent (If access to your city hall website through a digital certificate)"; readonly deprecated: false; readonly example: null; }; readonly nationalPortalTaxCalculationRegime: { readonly type: "string"; readonly description: "Identifier of the tax calculation regime. It must only be completed by companies classified as ME or EPP opting for Simples Nacional. Consult the need for this information with your city hall or accounting department."; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiCustomerInvoiceCancelRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly cancelOnlyOnAsaas: { readonly type: "boolean"; readonly description: "Cancel invoice only on Asaas"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiCustomerInvoiceGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "invoice"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique invoice identifier in Asaas"; readonly example: "inv_000000000232"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceGetResponseInvoiceStatus"; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000000002750"; readonly deprecated: false; }; readonly payment: { readonly type: "string"; readonly description: "Unique payment identifier in Asaas"; readonly example: "pay_145059895800"; readonly deprecated: false; }; readonly installment: { readonly type: "string"; readonly description: "Unique installment identifier in Asaas"; readonly deprecated: false; readonly example: null; }; readonly type: { readonly type: "string"; readonly description: "Invoice type"; readonly example: "NFS-e"; readonly deprecated: false; readonly enum: readonly ["NFS-e"]; }; readonly statusDescription: { readonly type: "string"; readonly description: "Description of the current status of the invoice"; readonly deprecated: false; readonly example: null; }; readonly serviceDescription: { readonly type: "string"; readonly description: "Description of invoice services"; readonly example: "Invoice 101940.\nDescription of Services: SYSTEMS ANALYSIS AND DEVELOPMENT"; readonly deprecated: false; }; readonly pdfUrl: { readonly type: "string"; readonly description: "Link to pdf file of the invoice issued"; readonly deprecated: false; readonly example: null; }; readonly xmlUrl: { readonly type: "string"; readonly description: "Link to xml file of the issued invoice"; readonly deprecated: false; readonly example: null; }; readonly rpsSerie: { readonly type: "string"; readonly description: "Invoice series"; readonly deprecated: false; readonly example: null; }; readonly rpsNumber: { readonly type: "string"; readonly description: "RPS converted to invoice"; readonly deprecated: false; readonly example: null; }; readonly number: { readonly type: "string"; readonly description: "Invoice number"; readonly deprecated: false; readonly example: null; }; readonly validationCode: { readonly type: "string"; readonly description: "Verification code"; readonly deprecated: false; readonly example: null; }; readonly value: { readonly type: "number"; readonly description: "Total value"; readonly example: 300; readonly deprecated: false; }; readonly deductions: { readonly type: "number"; readonly description: "Deductions. Deductions do not change the total value of the invoice, but they do change the ISS calculation basis."; readonly example: 10; readonly deprecated: false; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Invoice issuance date"; readonly format: "date"; readonly example: "2024-08-15"; readonly deprecated: false; }; readonly observations: { readonly type: "string"; readonly description: "Additional observations"; readonly example: "Monthly for June work."; readonly deprecated: false; }; readonly estimatedTaxesDescription: { readonly type: "string"; readonly description: "Estimated tax invoice"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Invoice identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly taxes: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceTaxesDTO"; }; readonly municipalServiceId: { readonly type: "string"; readonly description: "Unique municipal service identifier"; readonly deprecated: false; readonly example: null; }; readonly municipalServiceCode: { readonly type: "string"; readonly description: "Municipal Service Code"; readonly example: "1.01"; readonly deprecated: false; }; readonly municipalServiceName: { readonly type: "string"; readonly description: "Name of municipal service"; readonly example: "Systems analysis and development"; readonly deprecated: false; }; }; }; export declare const ApiCustomerInvoiceGetResponseInvoiceStatusSchema: { readonly type: "string"; readonly description: "Invoice status"; readonly example: "SCHEDULED"; readonly deprecated: false; readonly enum: readonly ["SCHEDULED", "AUTHORIZED", "PROCESSING_CANCELLATION", "CANCELED", "CANCELLATION_DENIED", "ERROR"]; }; export declare const ApiCustomerInvoiceTaxesDTOSchema: { readonly required: readonly ["retainIss", "cofins", "csll", "inss", "ir", "pis", "iss"]; readonly type: "object"; readonly properties: { readonly retainIss: { readonly required: readonly ["retainIss"]; readonly type: "boolean"; readonly description: "The invoice holder must withhold ISS or not"; readonly example: true; readonly deprecated: false; }; readonly cofins: { readonly required: readonly ["cofins"]; readonly type: "number"; readonly description: "COFINS rate"; readonly example: 1; readonly deprecated: false; }; readonly csll: { readonly required: readonly ["csll"]; readonly type: "number"; readonly description: "CSLL rate"; readonly example: 1; readonly deprecated: false; }; readonly inss: { readonly required: readonly ["inss"]; readonly type: "number"; readonly description: "INSS rate"; readonly example: 1; readonly deprecated: false; }; readonly ir: { readonly required: readonly ["ir"]; readonly type: "number"; readonly description: "IR rate"; readonly example: 1; readonly deprecated: false; }; readonly pis: { readonly required: readonly ["pis"]; readonly type: "number"; readonly description: "PIS rate"; readonly example: 1; readonly deprecated: false; }; readonly iss: { readonly required: readonly ["iss"]; readonly type: "number"; readonly description: "ISS rate"; readonly example: 1; readonly deprecated: false; }; }; readonly description: "Invoice taxes"; readonly deprecated: false; }; export declare const ApiCustomerInvoiceSaveRequestDTOSchema: { readonly required: readonly ["serviceDescription", "observations", "value", "deductions", "effectiveDate", "municipalServiceName"]; readonly type: "object"; readonly properties: { readonly payment: { readonly type: "string"; readonly description: "Unique payment identifier in Asaas"; readonly example: "pay_637959110194"; readonly deprecated: false; }; readonly installment: { readonly type: "string"; readonly description: "Unique installment identifier in Asaas"; readonly deprecated: false; readonly example: null; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000000002750"; readonly deprecated: false; }; readonly serviceDescription: { readonly required: readonly ["serviceDescription"]; readonly type: "string"; readonly description: "Description of invoice services"; readonly deprecated: false; readonly example: null; }; readonly observations: { readonly required: readonly ["observations"]; readonly type: "string"; readonly description: "Additional observations"; readonly example: "Monthly for June work."; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Invoice identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Total value"; readonly example: 300; readonly deprecated: false; }; readonly deductions: { readonly required: readonly ["deductions"]; readonly type: "number"; readonly description: "Deductions. Deductions do not change the total value of the invoice, but they do change the ISS calculation basis."; readonly example: 10; readonly deprecated: false; }; readonly effectiveDate: { readonly required: readonly ["effectiveDate"]; readonly type: "string"; readonly description: "Invoice issuance date"; readonly format: "date"; readonly example: "2024-08-20"; readonly deprecated: false; }; readonly municipalServiceId: { readonly type: "string"; readonly description: "Unique municipal service identifier"; readonly deprecated: false; readonly example: null; }; readonly municipalServiceCode: { readonly type: "string"; readonly description: "Municipal Service Code"; readonly example: "1.01"; readonly deprecated: false; }; readonly municipalServiceName: { readonly required: readonly ["municipalServiceName"]; readonly type: "string"; readonly description: "Name of the municipal service. If not provided, the municipalServiceCode attribute will be used as the name for identification."; readonly example: "Systems analysis and development"; readonly deprecated: false; }; readonly updatePayment: { readonly type: "boolean"; readonly description: "Update the Payment amount with the invoice taxes already deducted."; readonly deprecated: false; readonly example: null; }; readonly taxes: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceTaxesDTO"; }; }; }; export declare const ApiCustomerInvoiceUpdateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly serviceDescription: { readonly type: "string"; readonly description: "Description of invoice services"; readonly deprecated: false; readonly example: null; }; readonly observations: { readonly type: "string"; readonly description: "Additional observations"; readonly example: "Monthly for June work."; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Invoice identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly value: { readonly type: "number"; readonly description: "Total value"; readonly example: 300; readonly deprecated: false; }; readonly deductions: { readonly type: "number"; readonly description: "Deductions. Deductions do not change the total value of the invoice, but they do change the ISS calculation basis."; readonly example: 10; readonly deprecated: false; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Invoice issuance date"; readonly format: "date"; readonly example: "2024-08-20"; readonly deprecated: false; }; readonly updatePayment: { readonly type: "boolean"; readonly description: "Update the Payment amount with the invoice taxes already deducted."; readonly deprecated: false; readonly example: null; }; readonly taxes: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceTaxesDTO"; }; }; }; export declare const ApiCustomerInvoiceListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceGetResponseDTO"; }; }; }; }; export declare const ApiCustomerInvoiceListRequestInvoiceStatusSchema: { readonly type: "string"; readonly description: "Filter by situation"; readonly example: "SCHEDULED"; readonly deprecated: false; readonly enum: readonly ["SCHEDULED", "AUTHORIZED", "PROCESSING_CANCELLATION", "CANCELED", "CANCELLATION_DENIED", "ERROR"]; }; export declare const ApiCustomerInvoicePathIdRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiCustomerUpdateRequestGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly status: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestGetResponseStatus"; }; readonly personType: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestGetResponsePersonType"; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the account owner"; readonly example: "66625514000140"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Account owner name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly birthDate: { readonly type: "string"; readonly description: "Birthday (Required if the information is from an individual)"; readonly format: "date"; readonly example: "1995-04-12"; readonly deprecated: false; }; readonly companyName: { readonly type: "string"; readonly description: "Company Name"; readonly deprecated: false; readonly example: null; }; readonly companyType: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestGetResponseCompanyType"; }; readonly incomeValue: { readonly type: "number"; readonly description: "Billing/Monthly income"; readonly example: 250000; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Account's email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly phone: { readonly type: "string"; readonly description: "Telephone"; readonly deprecated: false; readonly example: null; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Cell phone"; readonly deprecated: false; readonly example: null; }; readonly postalCode: { readonly type: "string"; readonly description: "Address zip code"; readonly example: "89223005"; readonly deprecated: false; }; readonly address: { readonly type: "string"; readonly description: "Public place"; readonly example: "Av. Rolf Wiest"; readonly deprecated: false; }; readonly addressNumber: { readonly type: "string"; readonly description: "Address number"; readonly example: "659"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Address complement"; readonly deprecated: false; readonly example: null; }; readonly province: { readonly type: "string"; readonly description: "Neighborhood"; readonly example: "Bom retiro"; readonly deprecated: false; }; readonly city: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestCityDTO"; }; readonly denialReason: { readonly type: "string"; readonly description: "Reason why it is necessary to resend the information"; readonly deprecated: false; readonly example: null; }; readonly tradingName: { readonly type: "string"; readonly description: "Display name (auto-populated)"; readonly deprecated: false; readonly example: null; }; readonly site: { readonly type: "string"; readonly description: "Web site"; readonly deprecated: false; readonly example: null; }; readonly commercialInfoExpiration: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestCommercialInfoExpirationResponseDTO"; }; }; }; export declare const ApiCustomerUpdateRequestGetResponseStatusSchema: { readonly type: "string"; readonly description: "Account status"; readonly example: "APPROVED"; readonly deprecated: false; readonly enum: readonly ["APPROVED", "AWAITING_ACTION_AUTHORIZATION", "DENIED", "PENDING"]; }; export declare const ApiCustomerUpdateRequestGetResponsePersonTypeSchema: { readonly type: "string"; readonly description: "Person Type"; readonly example: "JURIDICA"; readonly deprecated: false; readonly enum: readonly ["JURIDICA", "FISICA"]; }; export declare const ApiCustomerUpdateRequestGetResponseCompanyTypeSchema: { readonly type: "string"; readonly description: "Type of company (only when Legal Entity)"; readonly example: "MEI"; readonly deprecated: false; readonly enum: readonly ["MEI", "LIMITED", "INDIVIDUAL", "ASSOCIATION"]; }; export declare const ApiCustomerUpdateRequestCityDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "city"; readonly deprecated: false; }; readonly id: { readonly type: "integer"; readonly description: "Unique city identifier in Asaas"; readonly format: "int32"; readonly example: 13660; readonly deprecated: false; }; readonly ibgeCode: { readonly type: "string"; readonly description: "IBGE Code"; readonly example: "4209102"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "City's name"; readonly example: "Joinville"; readonly deprecated: false; }; readonly districtCode: { readonly type: "string"; readonly description: "District code"; readonly example: "05"; readonly deprecated: false; }; readonly district: { readonly type: "string"; readonly description: "District name"; readonly example: "Joinville"; readonly deprecated: false; }; readonly state: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestCityState"; }; }; readonly description: "City information registered in your account"; readonly deprecated: false; }; export declare const ApiCustomerUpdateRequestCityStateSchema: { readonly type: "string"; readonly description: "State abbreviation (SP, RJ, SC, ...)"; readonly example: "SC"; readonly deprecated: false; readonly enum: readonly ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RR", "RO", "RJ", "RN", "RS", "SC", "SP", "SE", "TO"]; }; export declare const ApiCustomerUpdateRequestSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly personType: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestSaveRequestPersonType"; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the account owner"; readonly example: "66625514000140"; readonly deprecated: false; }; readonly birthDate: { readonly type: "string"; readonly description: "Birthday (Required if the information is from an individual)"; readonly format: "date"; readonly example: "1995-04-12"; readonly deprecated: false; }; readonly companyType: { readonly $ref: "#/components/schemas/ApiCustomerUpdateRequestSaveRequestCompanyType"; }; readonly incomeValue: { readonly type: "number"; readonly description: "Billing/Monthly income"; readonly example: 25000; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Account's email"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly phone: { readonly type: "string"; readonly description: "Telephone"; readonly deprecated: false; readonly example: null; }; readonly mobilePhone: { readonly type: "string"; readonly description: "Cell phone"; readonly deprecated: false; readonly example: null; }; readonly site: { readonly type: "string"; readonly description: "Web site"; readonly deprecated: false; readonly example: null; }; readonly postalCode: { readonly type: "string"; readonly description: "Address zip code"; readonly example: "89223005"; readonly deprecated: false; }; readonly address: { readonly type: "string"; readonly description: "Public place"; readonly example: "Av. Rolf Wiest"; readonly deprecated: false; }; readonly addressNumber: { readonly type: "string"; readonly description: "Address number"; readonly example: "659"; readonly deprecated: false; }; readonly complement: { readonly type: "string"; readonly description: "Address complement"; readonly deprecated: false; readonly example: null; }; readonly province: { readonly type: "string"; readonly description: "Neighborhood"; readonly example: "Bom Retiro"; readonly deprecated: false; }; }; }; export declare const ApiCustomerUpdateRequestSaveRequestPersonTypeSchema: { readonly type: "string"; readonly description: "Person Type"; readonly example: "JURIDICA"; readonly deprecated: false; readonly enum: readonly ["JURIDICA", "FISICA"]; }; export declare const ApiCustomerUpdateRequestSaveRequestCompanyTypeSchema: { readonly type: "string"; readonly description: "Type of company (only when Legal Entity)"; readonly example: "MEI"; readonly deprecated: false; readonly enum: readonly ["MEI", "LIMITED", "INDIVIDUAL", "ASSOCIATION"]; }; export declare const ApiFinanceBalanceResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly balance: { readonly type: "number"; readonly description: "Account balance"; readonly example: 5210.96; readonly deprecated: false; }; }; }; export declare const ApiFinanceGetPaymentStatisticsResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly quantity: { readonly type: "integer"; readonly description: "Number of charges"; readonly format: "int32"; readonly example: 23; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Amount"; readonly example: 9270.4; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Total net worth"; readonly example: 9121.54; readonly deprecated: false; }; }; }; export declare const ApiFinanceGetPaymentStatisticsRequestBillingTypeSchema: { readonly type: "string"; readonly description: "Filter by payment method"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["BOLETO", "CREDIT_CARD", "TRANSFER", "DEPOSIT", "DEBIT_CARD", "PIX"]; }; export declare const ApiFinanceGetPaymentStatisticsRequestPaymentStatusSchema: { readonly type: "string"; readonly description: "Filter by status"; readonly example: "CONFIRMED"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE"]; }; export declare const ApiFinanceGetSplitStatisticsResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly income: { readonly type: "number"; readonly description: "Amounts receivable"; readonly example: 5210.96; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Values to be sent"; readonly example: 9270.4; readonly deprecated: false; }; }; }; export declare const ApiFinancialTransactionListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "financialTransaction"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique transaction identifier in Asaas"; readonly example: "ftn_000015274322"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Transaction value"; readonly example: -5.99; readonly deprecated: false; }; readonly balance: { readonly type: "number"; readonly description: "Value in account at the time of the transaction"; readonly example: 3772.81; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiFinancialTransactionGetResponseFinancialTransactionType"; }; readonly date: { readonly type: "string"; readonly description: "Transaction date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Transaction description"; readonly example: "Taxa de transferência para conta bancária"; readonly deprecated: false; }; readonly paymentId: { readonly type: "string"; readonly description: "Payment identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly splitId: { readonly type: "string"; readonly description: "Split identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly transferId: { readonly type: "string"; readonly description: "Transfer identifier (If any)"; readonly example: "b26df110-498b-40ba-b5c6-1428de4d59c7"; readonly deprecated: false; }; readonly anticipationId: { readonly type: "string"; readonly description: "Anticipation identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly billId: { readonly type: "string"; readonly description: "Bill payment identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly invoiceId: { readonly type: "string"; readonly description: "Invoice identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly paymentDunningId: { readonly type: "string"; readonly description: "Payment dunning identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly creditBureauReportId: { readonly type: "string"; readonly description: "Serasa consultation identifier (If any)"; readonly deprecated: false; readonly example: null; }; }; }; }; }; }; export declare const ApiFinancialTransactionGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "financialTransaction"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique transaction identifier in Asaas"; readonly example: "ftn_000015274322"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Transaction value"; readonly example: -5.99; readonly deprecated: false; }; readonly balance: { readonly type: "number"; readonly description: "Value in account at the time of the transaction"; readonly example: 3772.81; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiFinancialTransactionGetResponseFinancialTransactionType"; }; readonly date: { readonly type: "string"; readonly description: "Transaction date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Transaction description"; readonly example: "Taxa de transferência para conta bancária"; readonly deprecated: false; }; readonly paymentId: { readonly type: "string"; readonly description: "Payment identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly splitId: { readonly type: "string"; readonly description: "Split identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly transferId: { readonly type: "string"; readonly description: "Transfer identifier (If any)"; readonly example: "b26df110-498b-40ba-b5c6-1428de4d59c7"; readonly deprecated: false; }; readonly anticipationId: { readonly type: "string"; readonly description: "Anticipation identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly billId: { readonly type: "string"; readonly description: "Bill payment identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly invoiceId: { readonly type: "string"; readonly description: "Invoice identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly paymentDunningId: { readonly type: "string"; readonly description: "Payment dunning identifier (If any)"; readonly deprecated: false; readonly example: null; }; readonly creditBureauReportId: { readonly type: "string"; readonly description: "Serasa consultation identifier (If any)"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiFinancialTransactionGetResponseFinancialTransactionTypeSchema: { readonly type: "string"; readonly description: "Transaction type"; readonly example: "TRANSFER_FEE"; readonly deprecated: false; readonly enum: readonly ["PAYMENT_RECEIVED", "TRANSFER", "TRANSFER_FEE", "TRANSFER_REVERSAL", "REVERSAL", "PAYMENT_REVERSAL", "PAYMENT_REFUND_CANCELLED", "PAYMENT_FEE", "PAYMENT_FEE_REVERSAL", "PAYMENT_CUSTODY_BLOCK", "PAYMENT_CUSTODY_BLOCK_REVERSAL", "PHONE_CALL_NOTIFICATION_FEE", "PROMOTIONAL_CODE_CREDIT", "DEBIT", "DEBIT_REVERSAL", "DEBT_RECOVERY_NEGOTIATION_FINANCIAL_CHARGES", "RECEIVABLE_ANTICIPATION_GROSS_CREDIT", "RECEIVABLE_ANTICIPATION_FEE", "RECEIVABLE_ANTICIPATION_DEBIT", "RECEIVABLE_ANTICIPATION_PARTNER_SETTLEMENT", "BILL_PAYMENT", "BILL_PAYMENT_FEE", "BILL_PAYMENT_CANCELLED", "BILL_PAYMENT_FEE_CANCELLED", "BILL_PAYMENT_REFUNDED", "POSTAL_SERVICE_FEE", "INTERNAL_TRANSFER_DEBIT", "INTERNAL_TRANSFER_CREDIT", "INTERNAL_TRANSFER_REVERSAL", "CREDIT", "PARTIAL_PAYMENT", "PAYMENT_MESSAGING_NOTIFICATION_FEE", "PAYMENT_SMS_NOTIFICATION_FEE", "PAYMENT_DUNNING_REQUEST_FEE", "PAYMENT_DUNNING_RECEIVED_FEE", "PAYMENT_DUNNING_RECEIVED_IN_CASH_FEE", "PAYMENT_DUNNING_CANCELLATION_FEE", "CUSTOMER_COMMISSION_SETTLEMENT_CREDIT", "CUSTOMER_COMMISSION_SETTLEMENT_DEBIT", "PROMOTIONAL_CODE_DEBIT", "REFUND_REQUEST_FEE", "REFUND_REQUEST_CANCELLED", "REFUND_REQUEST_FEE_REVERSAL", "INVOICE_FEE", "PRODUCT_INVOICE_FEE", "CONSUMER_INVOICE_FEE", "ASAAS_CARD_RECHARGE", "ASAAS_CARD_RECHARGE_REVERSAL", "ASAAS_CARD_BALANCE_REFUND", "CHARGEBACK", "CHARGEBACK_REVERSAL", "ASAAS_CARD_BILL_PAYMENT", "ASAAS_CARD_BILL_PAYMENT_REFUND", "ASAAS_CARD_TRANSACTION", "ASAAS_CARD_CASHBACK", "ASAAS_CARD_CREDIT_VOUCHER", "ASAAS_CARD_CREDIT_VOUCHER_REFUND", "ASAAS_CARD_TRANSACTION_FEE", "ASAAS_CARD_TRANSACTION_WITHDRAWAL_FEE", "ASAAS_CARD_TRANSACTION_IOF_FEE", "ASAAS_CARD_TRANSACTION_REFUND", "ASAAS_CARD_TRANSACTION_FEE_REFUND", "ASAAS_CARD_TRANSACTION_WITHDRAWAL_FEE_REFUND", "ASAAS_CARD_TRANSACTION_PARTIAL_REFUND", "ASAAS_CARD_TRANSACTION_REFUND_CANCELLATION", "ASAAS_CARD_TRANSACTION_PARTIAL_REFUND_CANCELLATION", "ASAAS_MONEY_PAYMENT_COMPROMISED_BALANCE", "ASAAS_MONEY_PAYMENT_COMPROMISED_BALANCE_REFUND", "ASAAS_MONEY_PAYMENT_ANTICIPATION_FEE", "ASAAS_MONEY_PAYMENT_ANTICIPATION_FEE_REFUND", "ASAAS_MONEY_PAYMENT_FINANCING_FEE", "ASAAS_MONEY_PAYMENT_FINANCING_FEE_REFUND", "ASAAS_MONEY_TRANSACTION_CASHBACK", "ASAAS_MONEY_TRANSACTION_CASHBACK_REFUND", "ASAAS_MONEY_TRANSACTION_CHARGEBACK", "ASAAS_MONEY_TRANSACTION_CHARGEBACK_REVERSAL", "CHARGED_FEE_REFUND", "PIX_TRANSACTION_DEBIT", "PIX_TRANSACTION_DEBIT_REFUND", "PIX_TRANSACTION_CREDIT", "PIX_TRANSACTION_CREDIT_FEE", "PIX_TRANSACTION_CREDIT_REFUND", "PIX_TRANSACTION_CREDIT_REFUND_CANCELLATION", "PIX_TRANSACTION_DEBIT_FEE", "CREDIT_BUREAU_REPORT", "CONTRACTUAL_EFFECT_SETTLEMENT", "CONTRACTUAL_EFFECT_SETTLEMENT_REVERSAL", "FREE_PAYMENT_USE", "MOBILE_PHONE_RECHARGE", "REFUND_MOBILE_PHONE_RECHARGE", "CANCEL_MOBILE_PHONE_RECHARGE", "BACEN_JUDICIAL_LOCK", "BACEN_JUDICIAL_UNLOCK", "BACEN_JUDICIAL_TRANSFER", "INSTANT_TEXT_MESSAGE_FEE", "ASAAS_DEBIT_CARD_REQUEST_FEE", "ASAAS_PREPAID_CARD_REQUEST_FEE", "EXTERNAL_SETTLEMENT_CONTRACTUAL_EFFECT_BATCH_CREDIT", "EXTERNAL_SETTLEMENT_CONTRACTUAL_EFFECT_BATCH_REVERSAL", "CHILD_ACCOUNT_KNOWN_YOUR_CUSTOMER_BATCH_FEE", "CONTRACTED_CUSTOMER_PLAN_FEE", "ACCOUNT_INACTIVITY_FEE", "PAYMENT_ORIGIN_CHANNEL_FEE", "PAYMENT_SPLIT_DIVERGENCE_BLOCK", "PAYMENT_SPLIT_DIVERGENCE_BLOCK_REVERSAL", "CUSTOMER_ACCOUNT_PAYMENT_BONUS_FEE", "RECEIVABLE_ANTICIPATION_PAYMENT_FEE", "ASAAS_MONEY_DONATION_DEBIT", "ASAAS_MONEY_DONATION_DEBIT_REFUND", "ASAAS_MONEY_PAYMENT_DEBIT", "ASAAS_MONEY_PAYMENT_DEBIT_REFUND", "CUSTOMER_COMMISSION_CHECKOUT", "RECEIVABLE_ANTICIPATION_CREDIT"]; }; export declare const ApiInstallmentPaymentBookResponseDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiInstallmentGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "installment"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique installment identifier in Asaas"; readonly example: "2765d086-c7c5-5cca-898a-4262d212587c"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Installment amount"; readonly example: 360; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net installment amount"; readonly example: 312.12; readonly deprecated: false; }; readonly paymentValue: { readonly type: "number"; readonly description: "Value of each installment"; readonly example: 30; readonly deprecated: false; }; readonly installmentCount: { readonly type: "integer"; readonly description: "Number of installments"; readonly format: "int32"; readonly example: 12; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiInstallmentGetResponseBillingType"; }; readonly paymentDate: { readonly type: "string"; readonly description: "Bill settlement date on Asaas"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Description of the installment"; readonly example: "Order 056984"; readonly deprecated: false; }; readonly expirationDay: { readonly type: "integer"; readonly description: "Due date of each installment"; readonly format: "int32"; readonly example: 31; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Installment creation date"; readonly format: "date"; readonly example: "2021-01-19"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique identifier of the customer to whom the installment belongs"; readonly example: "cus_000000001645"; readonly deprecated: false; }; readonly paymentLink: { readonly type: "string"; readonly description: "Unique identifier of the payment link to which the installment belongs"; readonly example: "997152082166122"; readonly deprecated: false; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "URL of proof of confirmation, receipt, reversal or removal."; readonly deprecated: false; readonly example: null; }; readonly chargeback: { readonly $ref: "#/components/schemas/ApiPaymentChargebackResponseDTO"; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiPaymentSaveWithCreditCardCreditCardDTO"; }; readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the installment has been removed"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiInstallmentGetResponseBillingTypeSchema: { readonly type: "string"; readonly description: "Form of payment"; readonly example: "CREDIT_CARD"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "TRANSFER", "DEPOSIT", "PIX"]; }; export declare const ApiPaymentSaveWithCreditCardCreditCardDTOSchema: { readonly type: "object"; readonly properties: { readonly creditCardNumber: { readonly type: "string"; readonly description: "Last 4 digits of the card used"; readonly example: "8829"; readonly deprecated: false; }; readonly creditCardBrand: { readonly $ref: "#/components/schemas/ApiPaymentSaveWithCreditCardCreditCardCreditCardBrand"; }; readonly creditCardToken: { readonly type: "string"; readonly description: "Credit card token if tokenization is active."; readonly deprecated: false; readonly example: null; }; }; readonly description: "Credit card information"; readonly deprecated: false; }; export declare const ApiPaymentSaveWithCreditCardCreditCardCreditCardBrandSchema: { readonly type: "string"; readonly description: "Flag of the card used"; readonly example: "VISA"; readonly deprecated: false; readonly enum: readonly ["VISA", "MASTERCARD", "ELO", "DINERS", "DISCOVER", "AMEX", "HIPERCARD", "CABAL", "BANESCARD", "CREDZ", "SOROCRED", "CREDSYSTEM", "JCB", "UNKNOWN"]; }; export declare const ApiInstallmentSaveRequestDTOSchema: { readonly required: readonly ["installmentCount", "customer", "value", "billingType", "dueDate"]; readonly type: "object"; readonly properties: { readonly installmentCount: { readonly required: readonly ["installmentCount"]; readonly type: "integer"; readonly description: "Number of installments"; readonly format: "int32"; readonly example: 3; readonly deprecated: false; }; readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Value of each installment"; readonly example: 100; readonly deprecated: false; }; readonly totalValue: { readonly type: "number"; readonly description: "Total installment amount"; readonly example: 150; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiInstallmentSaveRequestBillingType"; }; readonly dueDate: { readonly required: readonly ["dueDate"]; readonly type: "string"; readonly description: "Due date of the first installment"; readonly format: "date"; readonly example: "2025-07-08"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Installment description (max. 500 characters)"; readonly example: "Installment 08652"; readonly deprecated: false; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; readonly daysAfterDueDateToRegistrationCancellation: { readonly type: "integer"; readonly description: "Days after registration cancellation deadline (only for bank slip)"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly paymentExternalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly splits: { readonly type: "array"; readonly description: "Split Settings"; readonly deprecated: false; readonly items: { readonly required: readonly ["walletId"]; readonly type: "object"; readonly properties: { readonly walletId: { readonly required: readonly ["walletId"]; readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly deprecated: false; readonly example: null; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly deprecated: false; readonly example: null; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalFixedValue: { readonly type: "number"; readonly description: "(Instalments only). Amount that will be split relative to the total amount that will be paid in installments."; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; readonly installmentNumber: { readonly type: "integer"; readonly description: "Installment number to which the split will be linked. Cannot be provided along with the 'totalFixedValue' field"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; }; }; }; }; }; export declare const ApiInstallmentSaveRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentDiscountDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Percentage or fixed amount of discount to be applied to the Payment amount"; readonly example: 10; readonly deprecated: false; }; readonly dueDateLimitDays: { readonly type: "integer"; readonly description: "Days before expiration to apply discount. Ex: 0 = until expiration, 1 = up to one day before, 2 = up to 2 days before, and so on"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDiscountType"; }; }; readonly description: "Discount information"; readonly deprecated: false; }; export declare const ApiPaymentDiscountDiscountTypeSchema: { readonly type: "string"; readonly description: "Discount type"; readonly example: "PERCENTAGE"; readonly deprecated: false; readonly enum: readonly ["FIXED", "PERCENTAGE"]; }; export declare const ApiPaymentInterestRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Percentage of interest per month on the amount charged for payment after maturity"; readonly deprecated: false; readonly example: null; }; }; readonly description: "Interest information for payment after due date"; readonly deprecated: false; }; export declare const ApiPaymentFineRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Percentage of fine on the amount of the charge for payment after the due date"; readonly deprecated: false; readonly example: null; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestFineType"; }; }; readonly description: "Fine information for payment after due date"; readonly deprecated: false; }; export declare const ApiPaymentFineRequestFineTypeSchema: { readonly type: "string"; readonly description: "Fine type"; readonly example: "FIXED"; readonly deprecated: false; readonly enum: readonly ["FIXED", "PERCENTAGE"]; }; export declare const ApiInstallmentSplitRequestDTOSchema: { readonly required: readonly ["walletId"]; readonly type: "object"; readonly properties: { readonly walletId: { readonly required: readonly ["walletId"]; readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly deprecated: false; readonly example: null; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly deprecated: false; readonly example: null; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalFixedValue: { readonly type: "number"; readonly description: "(Instalments only). Amount that will be split relative to the total amount that will be paid in installments."; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; readonly installmentNumber: { readonly type: "integer"; readonly description: "Installment number to which the split will be linked. Cannot be provided along with the 'totalFixedValue' field"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiInstallmentUpdateSplitRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly splits: { readonly type: "array"; readonly description: "Split data to update"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiInstallmentSplitRequestDTO"; }; }; }; }; export declare const ApiInstallmentUpdateSplitResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly splits: { readonly type: "array"; readonly description: "Split array"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique split identifier in Asaas"; readonly example: "fd41396a-7453-47d0-9411-c8543522591d"; readonly deprecated: false; }; readonly walletId: { readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly example: "7bafd95a-e783-4a62-9be1-23999af742c6"; readonly deprecated: false; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the charge is received"; readonly example: 20.32; readonly deprecated: false; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalValue: { readonly type: "number"; readonly description: "Amount that will be split relative to the total amount that will be paid"; readonly example: 20.32; readonly deprecated: false; }; readonly cancellationReason: { readonly $ref: "#/components/schemas/ApiInstallmentSplitGetResponsePaymentSplitCancellationReason"; }; readonly status: { readonly $ref: "#/components/schemas/ApiInstallmentSplitGetResponsePaymentSplitStatus"; }; readonly externalReference: { readonly type: "string"; readonly description: "Unique identifier of split in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; readonly installmentNumber: { readonly type: "integer"; readonly description: "Installment to which the split is linked"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; }; }; }; }; }; export declare const ApiInstallmentSplitGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique split identifier in Asaas"; readonly example: "fd41396a-7453-47d0-9411-c8543522591d"; readonly deprecated: false; }; readonly walletId: { readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly example: "7bafd95a-e783-4a62-9be1-23999af742c6"; readonly deprecated: false; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the charge is received"; readonly example: 20.32; readonly deprecated: false; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalValue: { readonly type: "number"; readonly description: "Amount that will be split relative to the total amount that will be paid"; readonly example: 20.32; readonly deprecated: false; }; readonly cancellationReason: { readonly $ref: "#/components/schemas/ApiInstallmentSplitGetResponsePaymentSplitCancellationReason"; }; readonly status: { readonly $ref: "#/components/schemas/ApiInstallmentSplitGetResponsePaymentSplitStatus"; }; readonly externalReference: { readonly type: "string"; readonly description: "Unique identifier of split in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; readonly installmentNumber: { readonly type: "integer"; readonly description: "Installment to which the split is linked"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiInstallmentSplitGetResponsePaymentSplitCancellationReasonSchema: { readonly type: "string"; readonly description: "Reason for canceling the split"; readonly example: "PAYMENT_DELETED"; readonly deprecated: false; readonly enum: readonly ["PAYMENT_DELETED", "PAYMENT_OVERDUE", "PAYMENT_RECEIVED_IN_CASH", "PAYMENT_REFUNDED", "VALUE_DIVERGENCE_BLOCK", "WALLET_UNABLE_TO_RECEIVE"]; }; export declare const ApiInstallmentSplitGetResponsePaymentSplitStatusSchema: { readonly type: "string"; readonly description: "Split status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_CREDIT", "CANCELLED", "DONE", "REFUNDED", "BLOCKED_BY_VALUE_DIVERGENCE"]; }; export declare const ApiInstallmentListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiInstallmentGetResponseDTO"; }; }; }; }; export declare const ApiInstallmentDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the installment plan is removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique installment identifier in Asaas"; readonly example: "a2c890b-dd63-4b5a-9169-96c8d7828f4c"; readonly deprecated: false; }; }; }; export declare const ApiInstallmentRefundRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiMobilePhoneRechargeGetRequestDTOSchema: { readonly required: readonly ["id"]; readonly type: "object"; readonly properties: {}; }; export declare const ApiMobilePhoneRechargeGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique identifier for cell phone recharge on Asaas"; readonly example: "37c22147-4194-11ec-8061-0242ac120002"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Recharge value"; readonly example: 15; readonly deprecated: false; }; readonly phoneNumber: { readonly type: "string"; readonly description: "Cell phone number that was requested to be recharged"; readonly example: "63997365512"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiMobilePhoneRechargeGetResponseMobilePhoneRechargeStatus"; }; readonly canBeCancelled: { readonly type: "boolean"; readonly description: "Whether the top-up can be canceled"; readonly deprecated: false; readonly default: true; readonly example: null; }; readonly operatorName: { readonly type: "string"; readonly description: "Name of cell phone operator"; readonly example: "Vivo"; readonly deprecated: false; }; }; }; export declare const ApiMobilePhoneRechargeGetResponseMobilePhoneRechargeStatusSchema: { readonly type: "string"; readonly description: "Recharge status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "CONFIRMED", "CANCELLED", "REFUNDED", "WAITING_CRITICAL_ACTION"]; }; export declare const ApiMobilePhoneRechargeFindProviderResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Name of cell phone operator"; readonly example: "Vivo"; readonly deprecated: false; }; readonly values: { readonly type: "array"; readonly description: "Amounts available for recharge"; readonly example: readonly [{ readonly name: "R$ 12,00"; readonly bonus: "5.0"; readonly minValue: 1; readonly maxValue: 5; }, { readonly name: "R$ 30,00"; readonly bonus: "3.0"; readonly minValue: 20; readonly maxValue: 50; }]; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Package name"; readonly example: "R$ 12,00"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Package Description"; readonly deprecated: false; readonly example: null; }; readonly bonus: { readonly type: "string"; readonly description: "Package Bonuses"; readonly example: "0.0"; readonly deprecated: false; }; readonly minValue: { readonly type: "number"; readonly description: "Minimum top-up amount"; readonly example: 12; readonly deprecated: false; }; readonly maxValue: { readonly type: "number"; readonly description: "Maximum recharge value"; readonly example: 12; readonly deprecated: false; }; }; }; }; }; }; export declare const ApiMobilePhoneRechargeFindProviderResponseValuesDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Package name"; readonly example: "R$ 12,00"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Package Description"; readonly deprecated: false; readonly example: null; }; readonly bonus: { readonly type: "string"; readonly description: "Package Bonuses"; readonly example: "0.0"; readonly deprecated: false; }; readonly minValue: { readonly type: "number"; readonly description: "Minimum top-up amount"; readonly example: 12; readonly deprecated: false; }; readonly maxValue: { readonly type: "number"; readonly description: "Maximum recharge value"; readonly example: 12; readonly deprecated: false; }; }; }; export declare const ApiMobilePhoneRechargeSaveRequestDTOSchema: { readonly required: readonly ["value", "phoneNumber"]; readonly type: "object"; readonly properties: { readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Recharge value"; readonly example: 15; readonly deprecated: false; }; readonly phoneNumber: { readonly required: readonly ["phoneNumber"]; readonly type: "string"; readonly description: "Cellphone number"; readonly example: "63997365512"; readonly deprecated: false; }; }; }; export declare const ApiMobilePhoneRechargeListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiMobilePhoneRechargeGetResponseDTO"; }; }; }; }; export declare const ApiMyAccountDisableAccountResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly observations: { readonly type: "string"; readonly description: "Deletion information"; readonly example: "Conta desabilitada com sucesso"; readonly deprecated: false; }; }; }; export declare const ApiMyAccountGetAccountFeesResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly payment: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesPaymentDTO"; }; readonly transfer: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesTransferDTO"; }; readonly notification: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesNotificationDTO"; }; readonly creditBureauReport: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesCreditBureauReportDTO"; }; readonly invoice: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesInvoiceDTO"; }; readonly anticipation: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesAnticipationDTO"; }; }; }; export declare const ApiMyAccountGetAccountFeesPaymentDTOSchema: { readonly type: "object"; readonly properties: { readonly bankSlip: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesPaymentBankSlipDTO"; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesPaymentCreditCardDTO"; }; readonly debitCard: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesPaymentDebitCardDTO"; }; readonly pix: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesPaymentPixDTO"; }; }; readonly description: "Billing fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesPaymentBankSlipDTOSchema: { readonly type: "object"; readonly properties: { readonly defaultValue: { readonly type: "number"; readonly description: "Fee per charge"; readonly example: 6.96; readonly deprecated: false; }; readonly discountValue: { readonly type: "number"; readonly description: "Promotional fee (If any)"; readonly example: 3.99; readonly deprecated: false; }; readonly expirationDate: { readonly type: "string"; readonly description: "Promotional fee expiration date (If any)"; readonly format: "date-time"; readonly example: "2019-05-19 00:00:00"; readonly deprecated: false; }; readonly daysToReceive: { readonly type: "integer"; readonly description: "Days to receive billing"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; }; readonly description: "Boleto fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesPaymentCreditCardDTOSchema: { readonly type: "object"; readonly properties: { readonly operationValue: { readonly type: "number"; readonly description: "Operating fee per charge"; readonly example: 0.49; readonly deprecated: false; }; readonly oneInstallmentPercentage: { readonly type: "number"; readonly description: "Spot percentage rate"; readonly example: 2.99; readonly deprecated: false; }; readonly upToSixInstallmentsPercentage: { readonly type: "number"; readonly description: "Percentage rate for 2 to 6 installments"; readonly example: 2.99; readonly deprecated: false; }; readonly upToTwelveInstallmentsPercentage: { readonly type: "number"; readonly description: "Percentage rate for 7 to 12 installments"; readonly example: 2.99; readonly deprecated: false; }; readonly discountOneInstallmentPercentage: { readonly type: "number"; readonly description: "Promotional cash percentage rate (If any)"; readonly example: 1.99; readonly deprecated: false; }; readonly discountUpToSixInstallmentsPercentage: { readonly type: "number"; readonly description: "Percentage rate for 2 to 6 promotional installments (If any)"; readonly example: 1.99; readonly deprecated: false; }; readonly discountUpToTwelveInstallmentsPercentage: { readonly type: "number"; readonly description: "Percentage rate for 7 to 12 promotional installments (If any)"; readonly example: 1.99; readonly deprecated: false; }; readonly discountExpiration: { readonly type: "string"; readonly description: "Promotional fee expiration date (If any)"; readonly format: "date-time"; readonly example: "2019-05-19 00:00:00"; readonly deprecated: false; }; readonly daysToReceive: { readonly type: "integer"; readonly description: "Days to receive billing"; readonly format: "int32"; readonly example: 32; readonly deprecated: false; }; }; readonly description: "Credit card fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesPaymentDebitCardDTOSchema: { readonly type: "object"; readonly properties: { readonly operationValue: { readonly type: "number"; readonly description: "Operating fee per charge"; readonly example: 0.35; readonly deprecated: false; }; readonly defaultPercentage: { readonly type: "number"; readonly description: "Percentage rate per charge"; readonly example: 1.89; readonly deprecated: false; }; readonly daysToReceive: { readonly type: "integer"; readonly description: "Days to receive billing"; readonly format: "int32"; readonly example: 3; readonly deprecated: false; }; }; readonly description: "Debit card fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesPaymentPixDTOSchema: { readonly type: "object"; readonly properties: { readonly fixedFeeValue: { readonly type: "number"; readonly description: "Fixed fee (If any)"; readonly deprecated: false; readonly example: null; }; readonly fixedFeeValueWithDiscount: { readonly type: "number"; readonly description: "Promotional fixed rate (If any)"; readonly deprecated: false; readonly example: null; }; readonly percentageFee: { readonly type: "number"; readonly description: "Percentage rate (If any)"; readonly example: 0.99; readonly deprecated: false; }; readonly minimumFeeValue: { readonly type: "number"; readonly description: "Minimum fixed rate in case of percentage rate"; readonly example: 0.29; readonly deprecated: false; }; readonly maximumFeeValue: { readonly type: "number"; readonly description: "Maximum fixed rate in case of percentage rate"; readonly example: 1.99; readonly deprecated: false; }; readonly discountExpiration: { readonly type: "string"; readonly description: "Promotional fee expiration date (If any)"; readonly format: "date-time"; readonly deprecated: false; readonly example: null; }; readonly monthlyCreditsWithoutFee: { readonly type: "integer"; readonly description: "Number of free transactions per month"; readonly format: "int32"; readonly example: 30; readonly deprecated: false; }; readonly creditsReceivedOfCurrentMonth: { readonly type: "integer"; readonly description: "How many transactions have you received this month?"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; }; readonly description: "Pix Fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesTransferDTOSchema: { readonly type: "object"; readonly properties: { readonly monthlyTransfersWithoutFee: { readonly type: "integer"; readonly description: "Number of monthly free transactions"; readonly format: "int32"; readonly example: 30; readonly deprecated: false; }; readonly ted: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesTransferTedDTO"; }; readonly pix: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesTransferPixDTO"; }; }; readonly description: "Transfer fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesTransferTedDTOSchema: { readonly type: "object"; readonly properties: { readonly feeValue: { readonly type: "number"; readonly description: "Transfer fee via TED"; readonly example: 5; readonly deprecated: false; }; readonly consideredInMonthlyTransfersWithoutFee: { readonly type: "boolean"; readonly description: "Indicates whether the number of monthly free transactions considers TED"; readonly example: true; readonly deprecated: false; }; }; readonly description: "Fees for TED transfers"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesTransferPixDTOSchema: { readonly type: "object"; readonly properties: { readonly feeValue: { readonly type: "number"; readonly description: "Fee for sending transfers via Pix"; readonly example: 5; readonly deprecated: false; }; readonly discountValue: { readonly type: "number"; readonly description: "Promotional fee (If any)"; readonly deprecated: false; readonly example: null; }; readonly expirationDate: { readonly type: "string"; readonly description: "Promotional fee expiration date (If any)"; readonly format: "date-time"; readonly deprecated: false; readonly example: null; }; readonly consideredInMonthlyTransfersWithoutFee: { readonly type: "boolean"; readonly description: "Indicates whether the number of free monthly transactions considers Pix"; readonly example: true; readonly deprecated: false; }; }; readonly description: "Fees for Pix transfers"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesNotificationDTOSchema: { readonly type: "object"; readonly properties: { readonly phoneCallFeeValue: { readonly type: "number"; readonly description: "Fees per voice robot call"; readonly example: 0.55; readonly deprecated: false; }; readonly whatsAppFeeValue: { readonly type: "number"; readonly description: "Fees for notifications via WhatsApp"; readonly example: 0.55; readonly deprecated: false; }; readonly messagingFeeValue: { readonly type: "number"; readonly description: "Fees for sending emails and SMS"; readonly example: 0.99; readonly deprecated: false; }; }; readonly description: "Notification fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesCreditBureauReportDTOSchema: { readonly type: "object"; readonly properties: { readonly naturalPersonFeeValue: { readonly type: "number"; readonly description: "Fee for Serasa consultation for natural person"; readonly example: 16.99; readonly deprecated: false; }; readonly legalPersonFeeValue: { readonly type: "number"; readonly description: "Fee for Serasa consultation for legal person"; readonly example: 16.99; readonly deprecated: false; }; }; readonly description: "Serasa consultation fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesInvoiceDTOSchema: { readonly type: "object"; readonly properties: { readonly feeValue: { readonly type: "number"; readonly description: "Fee per service note issued"; readonly example: 0.99; readonly deprecated: false; }; }; readonly description: "Invoice fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesAnticipationDTOSchema: { readonly type: "object"; readonly properties: { readonly creditCard: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesAnticipationCreditCardDTO"; }; readonly bankSlip: { readonly $ref: "#/components/schemas/ApiMyAccountGetAccountFeesAnticipationBankSlipDTO"; }; }; readonly description: "Anticipation fees"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesAnticipationCreditCardDTOSchema: { readonly type: "object"; readonly properties: { readonly detachedMonthlyFeeValue: { readonly type: "number"; readonly description: "Monthly fee for upfront charges"; readonly example: 2.49; readonly deprecated: false; }; readonly installmentMonthlyFeeValue: { readonly type: "integer"; readonly description: "Monthly fee for installment payments"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; }; readonly description: "Credit card anticipation fee"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountFeesAnticipationBankSlipDTOSchema: { readonly type: "object"; readonly properties: { readonly monthlyFeePercentage: { readonly type: "number"; readonly description: "Monthly fee for invoice charges"; readonly example: 4.99; readonly deprecated: false; }; }; readonly description: "Anticipation fee on boletos"; readonly deprecated: false; }; export declare const ApiMyAccountGetAccountNumberResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly agency: { readonly type: "string"; readonly description: "Account agency"; readonly example: "0001"; readonly deprecated: false; }; readonly account: { readonly type: "string"; readonly description: "Account number"; readonly example: "6541"; readonly deprecated: false; }; readonly accountDigit: { readonly type: "string"; readonly description: "Account digit"; readonly example: "5"; readonly deprecated: false; }; }; }; export declare const ApiMyAccountGetStatusResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique account identifier in Asaas"; readonly example: "a910f50b-8745-4bc6-89fe-f1931c6a2e05"; readonly deprecated: false; }; readonly commercialInfo: { readonly $ref: "#/components/schemas/ApiMyAccountGetStatusResponseStatus"; }; readonly bankAccountInfo: { readonly $ref: "#/components/schemas/ApiMyAccountGetStatusResponseStatus"; }; readonly documentation: { readonly $ref: "#/components/schemas/ApiMyAccountGetStatusResponseStatus"; }; readonly general: { readonly $ref: "#/components/schemas/ApiMyAccountGetStatusResponseStatus"; }; }; }; export declare const ApiMyAccountGetStatusResponseStatusSchema: { readonly type: "string"; readonly description: "Status of sent business data"; readonly example: "APPROVED"; readonly deprecated: false; readonly enum: readonly ["PENDING", "APPROVED", "REJECTED", "AWAITING_APPROVAL"]; }; export declare const ApiNotificationBatchUpdateRequestDTOSchema: { readonly required: readonly ["customer"]; readonly type: "object"; readonly properties: { readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_000005401844"; readonly deprecated: false; }; readonly notifications: { readonly type: "array"; readonly description: "List of notification information"; readonly deprecated: false; readonly items: { readonly required: readonly ["id"]; readonly type: "object"; readonly properties: { readonly id: { readonly required: readonly ["id"]; readonly type: "string"; readonly description: "Unique identifier of the notification to be updated"; readonly example: "not_wuGp97JeCr7G"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Enable/disable notification"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForProvider: { readonly type: "boolean"; readonly description: "enable/disable the email sent to you"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForProvider: { readonly type: "boolean"; readonly description: "enable/disable the SMS sent to you"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable the email sent to your customer"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable the SMS sent to your customer"; readonly example: true; readonly deprecated: false; }; readonly phoneCallEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable voice notification sent to your customer"; readonly example: false; readonly deprecated: false; }; readonly whatsappEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable WhatsApp messages for your customer"; readonly example: false; readonly deprecated: false; }; readonly scheduleOffset: { readonly type: "integer"; readonly description: "Specifies how many days before the due date the notification must be sent.\n For the `PAYMENT_DUEDATE_WARNING` event, the accepted values are: `0`, `5`, `10`, `15` and `30`\n For the `PAYMENT_OVERDUE` event, the accepted values are: `1`, `7`, `15` and `30`"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; readonly enum: readonly [0, 1, 5, 7, 10, 15, 30]; }; }; }; }; }; }; export declare const ApiNotificationUpdateRequestDTOSchema: { readonly required: readonly ["id"]; readonly type: "object"; readonly properties: { readonly id: { readonly required: readonly ["id"]; readonly type: "string"; readonly description: "Unique identifier of the notification to be updated"; readonly example: "not_wuGp97JeCr7G"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Enable/disable notification"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForProvider: { readonly type: "boolean"; readonly description: "enable/disable the email sent to you"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForProvider: { readonly type: "boolean"; readonly description: "enable/disable the SMS sent to you"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable the email sent to your customer"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable the SMS sent to your customer"; readonly example: true; readonly deprecated: false; }; readonly phoneCallEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable voice notification sent to your customer"; readonly example: false; readonly deprecated: false; }; readonly whatsappEnabledForCustomer: { readonly type: "boolean"; readonly description: "enable/disable WhatsApp messages for your customer"; readonly example: false; readonly deprecated: false; }; readonly scheduleOffset: { readonly type: "integer"; readonly description: "Specifies how many days before the due date the notification must be sent.\n For the `PAYMENT_DUEDATE_WARNING` event, the accepted values are: `0`, `5`, `10`, `15` and `30`\n For the `PAYMENT_OVERDUE` event, the accepted values are: `1`, `7`, `15` and `30`"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; readonly enum: readonly [0, 1, 5, 7, 10, 15, 30]; }; }; }; export declare const ApiNotificationBatchUpdateResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly notifications: { readonly type: "array"; readonly description: "List of notification information"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "notification"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique notification identifier"; readonly example: "not_wuGp97JeCr7G"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000005401844"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Indicates whether notification is enabled"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForProvider: { readonly type: "boolean"; readonly description: "Indicates whether the email sent to you is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForProvider: { readonly type: "boolean"; readonly description: "Indicates whether the SMS sent to you is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether the email sent to the customer is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether the SMS sent to the customer is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly phoneCallEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether voice notification to the customer is enabled or disabled"; readonly example: false; readonly deprecated: false; }; readonly whatsappEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether the WhatsApp notification sent to the customer is enabled or disabled"; readonly example: false; readonly deprecated: false; }; readonly event: { readonly $ref: "#/components/schemas/ApiNotificationGetResponseNotificationEvent"; }; readonly scheduleOffset: { readonly type: "integer"; readonly description: "Specifies how many days before the due date the notification must be sent. Valid only for the `PAYMENT_DUEDATE_WARNING` and `PAYMENT_OVERDUE` events"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; readonly enum: readonly [0, 1, 5, 7, 10, 15, 30]; }; readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the notification was deleted"; readonly example: true; readonly deprecated: false; readonly default: true; }; }; }; }; }; }; export declare const ApiNotificationGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "notification"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique notification identifier"; readonly example: "not_wuGp97JeCr7G"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000005401844"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Indicates whether notification is enabled"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForProvider: { readonly type: "boolean"; readonly description: "Indicates whether the email sent to you is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForProvider: { readonly type: "boolean"; readonly description: "Indicates whether the SMS sent to you is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly emailEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether the email sent to the customer is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly smsEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether the SMS sent to the customer is enabled or disabled"; readonly example: true; readonly deprecated: false; }; readonly phoneCallEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether voice notification to the customer is enabled or disabled"; readonly example: false; readonly deprecated: false; }; readonly whatsappEnabledForCustomer: { readonly type: "boolean"; readonly description: "Indicates whether the WhatsApp notification sent to the customer is enabled or disabled"; readonly example: false; readonly deprecated: false; }; readonly event: { readonly $ref: "#/components/schemas/ApiNotificationGetResponseNotificationEvent"; }; readonly scheduleOffset: { readonly type: "integer"; readonly description: "Specifies how many days before the due date the notification must be sent. Valid only for the `PAYMENT_DUEDATE_WARNING` and `PAYMENT_OVERDUE` events"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; readonly enum: readonly [0, 1, 5, 7, 10, 15, 30]; }; readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the notification was deleted"; readonly example: true; readonly deprecated: false; readonly default: true; }; }; }; export declare const ApiNotificationGetResponseNotificationEventSchema: { readonly type: "string"; readonly description: "Kind of event"; readonly example: "PAYMENT_CREATED"; readonly deprecated: false; readonly enum: readonly ["PAYMENT_CREATED", "PAYMENT_UPDATED", "PAYMENT_RECEIVED", "PAYMENT_OVERDUE", "PAYMENT_DUEDATE_WARNING", "SEND_LINHA_DIGITAVEL"]; }; export declare const ApiNotificationListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiNotificationGetResponseDTO"; }; }; }; }; export declare const ApiPaymentCampaignPathIdRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiPaymentCampaignGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique identifier for your payments link in Asaas"; readonly example: "725104409743"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Payment link name"; readonly example: "Book sales"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Value of the payment link, if not informed, the payer can inform how much they want to pay"; readonly example: 50; readonly deprecated: false; }; readonly active: { readonly type: "boolean"; readonly description: "If the payments link is active"; readonly example: true; readonly deprecated: false; }; readonly chargeType: { readonly $ref: "#/components/schemas/ApiPaymentCampaignGetResponseChargeType"; }; readonly url: { readonly type: "string"; readonly description: "Payments link access link"; readonly example: "https://www.asaas.com/c/291089675759"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentCampaignGetResponseBillingType"; }; readonly subscriptionCycle: { readonly $ref: "#/components/schemas/ApiPaymentCampaignGetResponseCycle"; }; readonly description: { readonly type: "string"; readonly description: "Payments link description"; readonly example: "Any book for just R$: 50.00"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "End date"; readonly format: "date"; readonly example: "2024-09-05"; readonly deprecated: false; }; readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the payment link has been removed"; readonly example: false; readonly deprecated: false; }; readonly viewCount: { readonly type: "integer"; readonly description: "The number of views of your payments link"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly maxInstallmentCount: { readonly type: "integer"; readonly description: "Maximum number of installments that your customer can pay in installments for the payment link, if it is Installment."; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly dueDateLimitDays: { readonly type: "integer"; readonly description: "Number of business days that your customer can pay after the invoice is generated (For payment method such as Boleto)"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly notificationEnabled: { readonly type: "boolean"; readonly description: "Defines whether customers registered via the payments link will have notifications enabled"; readonly example: true; readonly deprecated: false; }; readonly isAddressRequired: { readonly type: "boolean"; readonly description: "Defines whether filling in the address will be obligatory in the charges."; readonly example: true; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field."; readonly example: "056984"; readonly deprecated: false; }; }; }; export declare const ApiPaymentCampaignGetResponseChargeTypeSchema: { readonly type: "string"; readonly description: "Charge type"; readonly example: "DETACHED"; readonly deprecated: false; readonly enum: readonly ["DETACHED", "RECURRENT", "INSTALLMENT"]; }; export declare const ApiPaymentCampaignGetResponseBillingTypeSchema: { readonly type: "string"; readonly description: "Allowed payment method"; readonly example: "UNDEFINED"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentCampaignGetResponseCycleSchema: { readonly type: "string"; readonly description: "Billing frequency, if the chargeType is RECURRENT"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiPaymentCampaignSaveRequestDTOSchema: { readonly required: readonly ["name", "billingType", "chargeType"]; readonly type: "object"; readonly properties: { readonly name: { readonly required: readonly ["name"]; readonly type: "string"; readonly description: "Payment link name"; readonly example: "Book sales"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payments link description"; readonly example: "Any book for just R$: 50.00"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "End date"; readonly example: "2024-09-05"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Value of the payment link, if not informed, the payer can inform how much they want to pay"; readonly example: 50; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentCampaignSaveRequestBillingType"; }; readonly chargeType: { readonly $ref: "#/components/schemas/ApiPaymentCampaignSaveRequestChargeType"; }; readonly dueDateLimitDays: { readonly type: "integer"; readonly description: "Number of business days that your customer can pay after the invoice is generated (For payment method such as Boleto)"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly subscriptionCycle: { readonly $ref: "#/components/schemas/ApiPaymentCampaignSaveRequestCycle"; }; readonly maxInstallmentCount: { readonly type: "integer"; readonly description: "Maximum number of installments that your customer can pay in installments for the payment link if the billing method selected is Installments. If not informed, the default value will be 1 installment"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; readonly default: 1; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field."; readonly example: "1287"; readonly deprecated: false; }; readonly notificationEnabled: { readonly type: "boolean"; readonly description: "Defines whether customers registered via the payments link will have notifications enabled. If not informed, the default value will be true"; readonly example: false; readonly deprecated: false; readonly default: true; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; readonly isAddressRequired: { readonly type: "boolean"; readonly description: "True to make it mandatory to fill in address data at checkout."; readonly example: true; readonly deprecated: false; }; }; }; export declare const ApiPaymentCampaignSaveRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Allowed payment method"; readonly example: "UNDEFINED"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentCampaignSaveRequestChargeTypeSchema: { readonly required: readonly ["chargeType"]; readonly type: "string"; readonly description: "Charge type"; readonly example: "DETACHED"; readonly deprecated: false; readonly enum: readonly ["DETACHED", "RECURRENT", "INSTALLMENT"]; }; export declare const ApiPaymentCampaignSaveRequestCycleSchema: { readonly type: "string"; readonly description: "Billing frequency, if the chargeType is RECURRENT"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiPaymentCallbackRequestDTOSchema: { readonly required: readonly ["successUrl"]; readonly type: "object"; readonly properties: { readonly successUrl: { readonly required: readonly ["successUrl"]; readonly type: "string"; readonly description: "URL that the customer will be redirected to after successful payment of the invoice or payment link"; readonly deprecated: false; readonly example: null; }; readonly autoRedirect: { readonly type: "boolean"; readonly description: "Define whether the customer will be automatically redirected or will just be informed with a button to return to the website. The default is true, if you want to disable it, enter false"; readonly deprecated: false; readonly example: null; }; }; readonly description: "Automatic redirection information after the payment of the link payment"; readonly deprecated: false; }; export declare const ApiPaymentCampaignUpdateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Payment link name"; readonly example: "Book sales"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payments link description"; readonly example: "Any book for just R$: 50.00"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "End date"; readonly example: "2024-09-05"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Value of the payment link, if not informed, the payer can inform how much they want to pay"; readonly example: 50; readonly deprecated: false; }; readonly active: { readonly type: "boolean"; readonly description: "Determines whether the payments link is active"; readonly example: true; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentCampaignUpdateRequestBillingType"; }; readonly chargeType: { readonly $ref: "#/components/schemas/ApiPaymentCampaignUpdateRequestChargeType"; }; readonly dueDateLimitDays: { readonly type: "integer"; readonly description: "Number of business days that your customer can pay after the invoice is generated (For payment method such as Boleto)"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly subscriptionCycle: { readonly $ref: "#/components/schemas/ApiPaymentCampaignUpdateRequestCycle"; }; readonly maxInstallmentCount: { readonly type: "integer"; readonly description: "Maximum number of installments that your customer can pay in installments for the payment link if the billing method selected is Installments. If not informed, the default value will be 1 installment"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; readonly default: 1; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field."; readonly example: "2323"; readonly deprecated: false; }; readonly notificationEnabled: { readonly type: "boolean"; readonly description: "Defines whether customers registered via the payments link will have notifications enabled. If not informed, the default value will be true"; readonly example: false; readonly deprecated: false; readonly default: true; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; }; }; export declare const ApiPaymentCampaignUpdateRequestBillingTypeSchema: { readonly type: "string"; readonly description: "Allowed payment method"; readonly example: "UNDEFINED"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentCampaignUpdateRequestChargeTypeSchema: { readonly type: "string"; readonly description: "Charge type"; readonly example: "DETACHED"; readonly deprecated: false; readonly enum: readonly ["DETACHED", "RECURRENT", "INSTALLMENT"]; }; export declare const ApiPaymentCampaignUpdateRequestCycleSchema: { readonly type: "string"; readonly description: "Billing frequency, if the chargeType is RECURRENT"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiPaymentCampaignListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentCampaignGetResponseDTO"; }; }; }; }; export declare const ApiPaymentCampaignDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the payment link has been removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique identifier for your payments link in Asaas"; readonly example: "725104409743"; readonly deprecated: false; }; }; }; export declare const ApiPaymentCampaignFilePathIdRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiPaymentCampaignFileGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique payment link image identifier in Asaas"; readonly example: "417d1fe7-f530-4368-935f-699045f2bf5d"; readonly deprecated: false; }; readonly main: { readonly type: "boolean"; readonly description: "Determines if this is the main image"; readonly example: true; readonly deprecated: false; }; readonly image: { readonly $ref: "#/components/schemas/ApiPaymentCampaignFileImageResponseDTO"; }; }; }; export declare const ApiPaymentCampaignFileImageResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly originalName: { readonly type: "string"; readonly description: "Original image name"; readonly example: "cover.png"; readonly deprecated: false; }; readonly size: { readonly type: "integer"; readonly description: "Image size"; readonly format: "int32"; readonly example: 50859; readonly deprecated: false; }; readonly extension: { readonly type: "string"; readonly description: "Image extension"; readonly example: "png"; readonly deprecated: false; }; readonly previewUrl: { readonly type: "string"; readonly description: "Link to download the image preview"; readonly example: "https://www.asaas.com/file/preview/XtW5OjqOBy3sskIcEMPj6yhr7T3aCLnSWEbIJd08gMNf3Rk7r5buwAXQ9xC2TNmg"; readonly deprecated: false; }; readonly downloadUrl: { readonly type: "string"; readonly description: "Link to download the image"; readonly example: "https://www.asaas.com/file/public/download/XtW5OjqOBy3sskIcEMPj6yhr7T3aCLnSWEbIJd08gMNf3Rk7r5buwAXQ9xC2TNmg"; readonly deprecated: false; }; }; readonly description: "Payments link image information"; readonly deprecated: false; }; export declare const ApiPaymentCampaignFileSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly main: { readonly type: "boolean"; readonly description: "true to set as the main image"; readonly example: true; readonly deprecated: false; }; readonly image: { readonly $ref: "#/components/schemas/File"; }; }; }; export declare const ApiPaymentCampaignFileListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentCampaignFileGetResponseDTO"; }; }; }; }; export declare const ApiPaymentCampaignFileDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the image was removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique payment link image identifier in Asaas"; readonly example: "417d1fe7-f530-4368-935f-699045f2bf5d"; readonly deprecated: false; }; }; }; export declare const ApiPaymentCheckoutConfigGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "paymentCheckoutConfig"; readonly deprecated: false; }; readonly logoBackgroundColor: { readonly type: "string"; readonly description: "Logo background color"; readonly example: "#00ff00"; readonly deprecated: false; }; readonly infoBackgroundColor: { readonly type: "string"; readonly description: "Background color of your information"; readonly example: "#000fff"; readonly deprecated: false; }; readonly fontColor: { readonly type: "string"; readonly description: "Font color of your information"; readonly example: "#00ff00"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Indicates whether personalization is enabled"; readonly example: true; readonly deprecated: false; readonly default: true; }; readonly logoUrl: { readonly type: "string"; readonly description: "Logo download link"; readonly deprecated: false; readonly example: null; }; readonly observations: { readonly type: "string"; readonly description: "Invoice personalization analysis notes"; readonly example: "Aprovado automaticamente pelo sistema."; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentCheckoutConfigGetResponseCustomerInvoiceConfigStatus"; }; }; }; export declare const ApiPaymentCheckoutConfigGetResponseCustomerInvoiceConfigStatusSchema: { readonly type: "string"; readonly description: "Invoice personalization status"; readonly example: "APPROVED"; readonly deprecated: false; readonly enum: readonly ["AWAITING_APPROVAL", "APPROVED", "REJECTED"]; }; export declare const ApiPaymentCheckoutConfigSaveRequestDTOSchema: { readonly required: readonly ["logoBackgroundColor", "infoBackgroundColor", "fontColor"]; readonly type: "object"; readonly properties: { readonly logoBackgroundColor: { readonly required: readonly ["logoBackgroundColor"]; readonly type: "string"; readonly description: "Logo background color"; readonly example: "#00ff00"; readonly deprecated: false; }; readonly infoBackgroundColor: { readonly required: readonly ["infoBackgroundColor"]; readonly type: "string"; readonly description: "Background color of your information"; readonly example: "#000fff"; readonly deprecated: false; }; readonly fontColor: { readonly required: readonly ["fontColor"]; readonly type: "string"; readonly description: "Font color of your information"; readonly example: "#00ff0"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Indicates whether personalization is enabled"; readonly example: true; readonly deprecated: false; }; readonly logoFile: { readonly $ref: "#/components/schemas/File"; }; }; }; export declare const ApiPaymentPayWithCreditCardRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly creditCard: { readonly $ref: "#/components/schemas/ApiCreditCardRequestDTO"; }; readonly creditCardHolderInfo: { readonly $ref: "#/components/schemas/ApiCreditCardHolderInfoRequestDTO"; }; readonly creditCardToken: { readonly type: "string"; readonly description: "Credit card token for using the credit card tokenization functionality. If informed, the fields above are not mandatory."; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "payment"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique payment identifier in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Payment creation date"; readonly format: "date"; readonly example: "2017-03-10"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique identifier of the customer to whom the payment belongs"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly subscription: { readonly type: "string"; readonly description: "Unique subscription identifier (when recurring billing)"; readonly deprecated: false; readonly example: null; }; readonly installment: { readonly type: "string"; readonly description: "Unique installment identifier (when billing in installments)"; readonly deprecated: false; readonly example: null; }; readonly paymentLink: { readonly type: "string"; readonly description: "Unique identifier of the payments link to which the payment belongs"; readonly deprecated: false; readonly example: null; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 129.9; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net value of the charge after discounting the Asaas fee"; readonly example: 124.9; readonly deprecated: false; }; readonly originalValue: { readonly type: "number"; readonly description: "Original amount of charge (filled when paid with interest and fine)"; readonly deprecated: false; readonly example: null; }; readonly interestValue: { readonly type: "number"; readonly description: "Calculated amount of interest and fine that must be paid after the charge is due"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Description of the payment"; readonly example: "Pedido 056984"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentGetResponseBillingType"; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiPaymentSaveWithCreditCardCreditCardDTO"; }; readonly canBePaidAfterDueDate: { readonly type: "boolean"; readonly description: "Informs whether the charge can be paid after the due date (Only for bank slip)"; readonly example: true; readonly deprecated: false; }; readonly pixTransaction: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction to which the payment belongs"; readonly deprecated: false; readonly example: null; }; readonly pixQrCodeId: { readonly type: "string"; readonly description: "Unique identifier of the static QrCode generated for a given Pix key"; readonly deprecated: false; readonly example: null; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentGetResponsePaymentStatus"; }; readonly dueDate: { readonly type: "string"; readonly description: "Payment due date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly originalDueDate: { readonly type: "string"; readonly description: "Original due date upon creation of the payment"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly paymentDate: { readonly type: "string"; readonly description: "Payment date on Asaas"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly clientPaymentDate: { readonly type: "string"; readonly description: "Date on which the customer paid the bank slip"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly installmentNumber: { readonly type: "integer"; readonly description: "Parcel number"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly invoiceUrl: { readonly type: "string"; readonly description: "Invoice URL"; readonly example: "https://www.asaas.com/i/080225913252"; readonly deprecated: false; }; readonly invoiceNumber: { readonly type: "string"; readonly description: "Bill number"; readonly example: "00005101"; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly deleted: { readonly type: "boolean"; readonly description: "Determines if the payment has been removed"; readonly example: false; readonly deprecated: false; }; readonly anticipated: { readonly type: "boolean"; readonly description: "Defines whether the charge was anticipated or is in the process of being anticipated"; readonly example: false; readonly deprecated: false; }; readonly anticipable: { readonly type: "boolean"; readonly description: "Determines whether the charge is anticipated"; readonly example: false; readonly deprecated: false; }; readonly creditDate: { readonly type: "string"; readonly description: "Date when the credit became available"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly estimatedCreditDate: { readonly type: "string"; readonly description: "Estimated date when the credit will be available"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "URL of proof of confirmation, receipt, reversal or removal"; readonly deprecated: false; readonly example: null; }; readonly nossoNumero: { readonly type: "string"; readonly description: "Unique identification of the bank slip"; readonly example: "6453"; readonly deprecated: false; }; readonly bankSlipUrl: { readonly type: "string"; readonly description: "URL to download the bank slip"; readonly example: "https://www.asaas.com/b/pdf/080225913252"; readonly deprecated: false; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineResponseDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestResponseDTO"; }; readonly split: { readonly type: "array"; readonly description: "Split Settings"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique split identifier in Asaas"; readonly example: "fd41396a-7453-47d0-9411-c8543522591d"; readonly deprecated: false; }; readonly walletId: { readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly example: "7bafd95a-e783-4a62-9be1-23999af742c6"; readonly deprecated: false; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the charge is received"; readonly example: 20.32; readonly deprecated: false; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalValue: { readonly type: "number"; readonly description: "Amount that will be split relative to the total amount that will be paid"; readonly example: 20.32; readonly deprecated: false; }; readonly cancellationReason: { readonly $ref: "#/components/schemas/ApiPaymentSplitGetResponsePaymentSplitCancellationReason"; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentSplitGetResponsePaymentSplitStatus"; }; readonly externalReference: { readonly type: "string"; readonly description: "Unique identifier of split in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; }; }; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; readonly daysAfterDueDateToRegistrationCancellation: { readonly type: "integer"; readonly description: "Days after registration cancellation deadline (only for bank slip)"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly chargeback: { readonly $ref: "#/components/schemas/ApiPaymentChargebackResponseDTO"; }; readonly refunds: { readonly type: "array"; readonly description: "Refunds information"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly dateCreated: { readonly type: "string"; readonly description: "Refund creation date"; readonly format: "date-time"; readonly example: "2024-10-18 10:19:06"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentRefundGetResponsePaymentRefundStatus"; }; readonly value: { readonly type: "number"; readonly description: "Refund value"; readonly example: 40; readonly deprecated: false; }; readonly endToEndIdentifier: { readonly type: "string"; readonly description: "(Pix only) Unique identifier of the Pix transaction at the Central Bank"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Description of the refund"; readonly deprecated: false; readonly example: null; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Refund effective date"; readonly format: "date-time"; readonly example: "2024-10-19 10:19:06"; readonly deprecated: false; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "Transaction receipt link"; readonly deprecated: false; readonly example: null; }; readonly refundedSplits: { readonly type: "array"; readonly description: "Refunded Splits, if any"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique split identifier"; readonly example: "cff860dd-148e-48ca-ac8e-849684175158"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Refunded value"; readonly example: 10; readonly deprecated: false; }; readonly done: { readonly type: "boolean"; readonly description: "Indicates whether the split was refunded"; readonly example: true; readonly deprecated: false; }; }; }; }; }; }; }; }; }; export declare const ApiPaymentGetResponseBillingTypeSchema: { readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "TRANSFER", "DEPOSIT", "PIX"]; }; export declare const ApiPaymentGetResponsePaymentStatusSchema: { readonly type: "string"; readonly description: "Payment status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE", "REFUNDED", "RECEIVED_IN_CASH", "REFUND_REQUESTED", "REFUND_IN_PROGRESS", "CHARGEBACK_REQUESTED", "CHARGEBACK_DISPUTE", "AWAITING_CHARGEBACK_REVERSAL", "DUNNING_REQUESTED", "DUNNING_RECEIVED", "AWAITING_RISK_ANALYSIS"]; }; export declare const ApiPaymentFineResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Fine amount in percentage"; readonly example: 1; readonly deprecated: false; }; }; readonly description: "Fine information for payment after due date"; readonly deprecated: false; }; export declare const ApiPaymentInterestResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Interest value in percentage"; readonly example: 2; readonly deprecated: false; }; }; readonly description: "Interest information for payment after due date"; readonly deprecated: false; }; export declare const ApiPaymentSplitGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique split identifier in Asaas"; readonly example: "fd41396a-7453-47d0-9411-c8543522591d"; readonly deprecated: false; }; readonly walletId: { readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly example: "7bafd95a-e783-4a62-9be1-23999af742c6"; readonly deprecated: false; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the charge is received"; readonly example: 20.32; readonly deprecated: false; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalValue: { readonly type: "number"; readonly description: "Amount that will be split relative to the total amount that will be paid"; readonly example: 20.32; readonly deprecated: false; }; readonly cancellationReason: { readonly $ref: "#/components/schemas/ApiPaymentSplitGetResponsePaymentSplitCancellationReason"; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentSplitGetResponsePaymentSplitStatus"; }; readonly externalReference: { readonly type: "string"; readonly description: "Unique identifier of split in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentSplitGetResponsePaymentSplitCancellationReasonSchema: { readonly type: "string"; readonly description: "Reason for canceling the split"; readonly example: "PAYMENT_DELETED"; readonly deprecated: false; readonly enum: readonly ["PAYMENT_DELETED", "PAYMENT_OVERDUE", "PAYMENT_RECEIVED_IN_CASH", "PAYMENT_REFUNDED", "VALUE_DIVERGENCE_BLOCK", "WALLET_UNABLE_TO_RECEIVE"]; }; export declare const ApiPaymentSplitGetResponsePaymentSplitStatusSchema: { readonly type: "string"; readonly description: "Split status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_CREDIT", "CANCELLED", "DONE", "REFUNDED", "BLOCKED_BY_VALUE_DIVERGENCE"]; }; export declare const ApiPaymentRefundGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly dateCreated: { readonly type: "string"; readonly description: "Refund creation date"; readonly format: "date-time"; readonly example: "2024-10-18 10:19:06"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentRefundGetResponsePaymentRefundStatus"; }; readonly value: { readonly type: "number"; readonly description: "Refund value"; readonly example: 40; readonly deprecated: false; }; readonly endToEndIdentifier: { readonly type: "string"; readonly description: "(Pix only) Unique identifier of the Pix transaction at the Central Bank"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Description of the refund"; readonly deprecated: false; readonly example: null; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Refund effective date"; readonly format: "date-time"; readonly example: "2024-10-19 10:19:06"; readonly deprecated: false; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "Transaction receipt link"; readonly deprecated: false; readonly example: null; }; readonly refundedSplits: { readonly type: "array"; readonly description: "Refunded Splits, if any"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique split identifier"; readonly example: "cff860dd-148e-48ca-ac8e-849684175158"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Refunded value"; readonly example: 10; readonly deprecated: false; }; readonly done: { readonly type: "boolean"; readonly description: "Indicates whether the split was refunded"; readonly example: true; readonly deprecated: false; }; }; }; }; }; }; export declare const ApiPaymentRefundGetResponsePaymentRefundStatusSchema: { readonly type: "string"; readonly description: "Refund status"; readonly example: "DONE"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_CRITICAL_ACTION_AUTHORIZATION", "AWAITING_CUSTOMER_EXTERNAL_AUTHORIZATION", "CANCELLED", "DONE"]; }; export declare const ApiPaymentRefundedSplitResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique split identifier"; readonly example: "cff860dd-148e-48ca-ac8e-849684175158"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Refunded value"; readonly example: 10; readonly deprecated: false; }; readonly done: { readonly type: "boolean"; readonly description: "Indicates whether the split was refunded"; readonly example: true; readonly deprecated: false; }; }; }; export declare const ApiPaymentPathIdRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiPaymentSaveRequestDTOSchema: { readonly required: readonly ["customer", "billingType", "value", "dueDate"]; readonly type: "object"; readonly properties: { readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentSaveRequestBillingType"; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Payment amount"; readonly example: 129.9; readonly deprecated: false; }; readonly dueDate: { readonly required: readonly ["dueDate"]; readonly type: "string"; readonly description: "Payment due date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payment description (max. 500 characters)"; readonly example: "Pedido 056984"; readonly deprecated: false; }; readonly daysAfterDueDateToRegistrationCancellation: { readonly type: "integer"; readonly description: "Days after registration cancellation deadline (only for bank slip)"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly installmentCount: { readonly type: "integer"; readonly description: "Number of installments (only in the case of installment payment)"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly totalValue: { readonly type: "number"; readonly description: "Enter the total amount of a charge that will be paid in installments (only in the case of an installment charge). If this field is sent, the installmentValue is not necessary, the calculation per installment will be automatic."; readonly deprecated: false; readonly example: null; }; readonly installmentValue: { readonly type: "number"; readonly description: "Value of each installment (only in the case of installment payment). Send this field if you want to define the value of each installment."; readonly deprecated: false; readonly example: null; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; readonly split: { readonly type: "array"; readonly description: "Split Settings"; readonly deprecated: false; readonly items: { readonly required: readonly ["walletId"]; readonly type: "object"; readonly properties: { readonly walletId: { readonly required: readonly ["walletId"]; readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly deprecated: false; readonly example: null; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly deprecated: false; readonly example: null; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalFixedValue: { readonly type: "number"; readonly description: "(Instalments only). Amount that will be split relative to the total amount that will be paid in installments."; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; }; }; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; }; }; export declare const ApiPaymentSaveRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentSplitRequestDTOSchema: { readonly required: readonly ["walletId"]; readonly type: "object"; readonly properties: { readonly walletId: { readonly required: readonly ["walletId"]; readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly deprecated: false; readonly example: null; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly deprecated: false; readonly example: null; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly totalFixedValue: { readonly type: "number"; readonly description: "(Instalments only). Amount that will be split relative to the total amount that will be paid in installments."; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentUpdateRequestDTOSchema: { readonly required: readonly ["billingType", "value", "dueDate"]; readonly type: "object"; readonly properties: { readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentUpdateRequestBillingType"; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Payment amount"; readonly example: 129.9; readonly deprecated: false; }; readonly dueDate: { readonly required: readonly ["dueDate"]; readonly type: "string"; readonly description: "Payment due date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payment description (max. 500 characters)"; readonly example: "Pedido 056984"; readonly deprecated: false; }; readonly daysAfterDueDateToRegistrationCancellation: { readonly type: "integer"; readonly description: "Days after registration cancellation deadline (only for bank slip)"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; readonly split: { readonly type: "array"; readonly description: "Split Settings"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentSplitRequestDTO"; }; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; }; }; export declare const ApiPaymentUpdateRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentGetResponseDTO"; }; }; }; }; export declare const ApiPaymentListRequestBillingTypeSchema: { readonly type: "string"; readonly description: "Filter by billing type"; readonly example: "UNDEFINED"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentListRequestPaymentStatusSchema: { readonly type: "string"; readonly description: "Filter by status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE", "REFUNDED", "RECEIVED_IN_CASH", "REFUND_REQUESTED", "REFUND_IN_PROGRESS", "CHARGEBACK_REQUESTED", "CHARGEBACK_DISPUTE", "AWAITING_CHARGEBACK_REVERSAL", "DUNNING_REQUESTED", "DUNNING_RECEIVED", "AWAITING_RISK_ANALYSIS"]; }; export declare const ApiPaymentListRequestInvoiceStatusSchema: { readonly type: "string"; readonly description: "Filter to return charges that have or do not have an invoice"; readonly example: "SCHEDULED"; readonly deprecated: false; readonly enum: readonly ["SCHEDULED", "AUTHORIZED", "PROCESSING_CANCELLATION", "CANCELED", "CANCELLATION_DENIED", "ERROR"]; }; export declare const ApiPaymentDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the charge has been removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique payment identifier in Asaas"; readonly example: "pay_pCczZjBBr6RL"; readonly deprecated: false; }; }; }; export declare const ApiPaymentIdentificationFieldResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly identificationField: { readonly type: "string"; readonly description: "Digitable bill line"; readonly example: "00190000090275928800021932978170187890000005000"; readonly deprecated: false; }; readonly nossoNumero: { readonly type: "string"; readonly description: "Unique identification of the bank slip"; readonly example: "6543"; readonly deprecated: false; }; readonly barCode: { readonly type: "string"; readonly description: "Bank slip bar code"; readonly example: "00191878900000050000000002759288002193297817"; readonly deprecated: false; }; }; }; export declare const ApiPaymentReceiveInCashRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly paymentDate: { readonly type: "string"; readonly description: "Date the customer made the payment"; readonly format: "date"; readonly example: "17/01/2025"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Amount paid by the customer"; readonly example: 129.9; readonly deprecated: false; }; readonly notifyCustomer: { readonly type: "boolean"; readonly description: "Send or not send notification of confirmed payment to the customer"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiPaymentBillingInfoResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly pix: { readonly $ref: "#/components/schemas/ApiPaymentPixQrCodeResponseDTO"; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiCreditCardTokenizeResponseDTO"; }; readonly bankSlip: { readonly $ref: "#/components/schemas/ApiBankSlipBillingInfoResponseDTO"; }; }; }; export declare const ApiPaymentPixQrCodeResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly encodedImage: { readonly type: "string"; readonly description: "QrCode image in base64"; readonly example: "=iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAFIBJREFUeF7t3dt2GzsOBNDk/z86s2aO5DnqpLVZDVCWHfgVJC6FKpC6tX/++vXr14/5GwQGgT8i8HMEMswYBM4R+BDIz58/X4pT9eA65nv0l9aj/dV8j+AqfzVD9e2uR/GP+Qs/4ZHGE36y3/MdgdyQ2k2oEcjzm/wI5MAQTRQpvBvQEYgQf7SnE1397u5nVs3vq+cEgWDVsGoDqv5F0N2CV/xvf8WS4lOCiBCyp/G614sQIqQIo/oVX/Wqn6l/+dOVMs1X+Mif7Gf+T1+DpABcTeC+bzcAyk92EWgE8hxB4VcdIOqf7CMQIQS7GjwCGYGUKKYTQvZS8IbNI5BHENMbhvD78ifIqwuUYF5tl8aqhNH+r15v+ppEJ7Lsab/KV6wRyHPIRXARRPtHII8fZI9ADp/sC5Dd9nQiab0InwpK/lK78pegtV8Dt9pPxV/1v/wulgrqvkOmDV0tePVds2q9apDqG4E8fvIuvKr9evsr1m4AUsJV16f7Vb8Ep3jan54Iuwh5lqfw2ZXP25wguwEQgUQQ5ScCar/s8q/6tF/1d/tP69X6EUj4bWM1XICLEPKf7k/zEeGrhNntP61X66v1zhXr0HEBnhI8JVT6mkn+la/2VwWf+u/G/9sLJG2wGlptgBr+2fa0/u43Ubr7JTzVzxHIAcGUIOl6Neyz7dV6uk8wEVT5Cs8RCK5AmoCaaGqQGqwGvtperWcEsvY28tu8iyWCj0AeERiBPCe4BtbqgFgWiALKnh6RqwXc4+oEkD/lL4FW61N81af9af1aL3uaj9YLX+2XvfwulgLIrgK77SmhlX/qTwTSCZCeqMpf+XTXl+aj9eKH9ss+Ajk8/mv3RBYhRyDZ49hGIM1fTkwnoiZM6m8E8hzR6oBI96u/8Qkih1V7SiBNkLFnXwf/6vhX+af9d3ze5rlYQ/C/i+BVgYrgVfsIBK9Jqg2c/WufM5y9Cyn8qgLQ/hHICOSBI1/tBBfBq/bfBFJ12L0/fZep+qJN8bonWpqv8kvfRFC/VG+av962rvpTPVftb/t09yohUkAUT4RJ46WEUH4jkLQDa+tHIDecRMARyPM3Edbo9v9VutKl/natH4GMQP7ILQ2E9AT88lcsTdBUoQJY/qoNkP+0Yd34pPlpfTdemvApHuLDu9k/3l27/4eptOC0Yan/7oYr325CKF63vRuvbjzeTQCqbwRyYKgASwXeLQD5G4H0fu4yAhmBPNVc98D4didId0GagLKrYXpNIf9pvfJXzee4XyeE8Knaq/Uq/xQv9Uv4CQ+eIEogtacACzABnl6JdteT5qMGp/iIELKn/av6E17ql/BbzW/5F4VyKHsKcEoArVd8AS5Byr8arv2KL/yrduUn/JW/9qeET9ef5TcCuSE5AnmvDwI1UNSv7QLRxFCCsqsAxU8nThpPE1fx0/rTelVPmr/q6c5P/lKBpPmrP3f75d+DrAb4eLGDR4emR3AKiAglf8pPhFTDRRjZ037IX3e+wk/4V/un/Wf9G4GcMEWEV0NFWBE0tSteN0Gr+Wm/BKp60v0jkENHUoCr69UwEUb2EcgjQsJ7Fa/TLyumAaoTVQQUQWRPT4RX+0vjaf0qAVavwGk8rU/7IT4qnvjFE0QE1x1O+9OGqeDUnjZE/rv9pfG0PsV7NwFTfmi96u/i65wgKdK39SOQR+A0oUV47d8t4DlB8NytVCcjkL9MIGnDpejqEZ/u14TqOnLP7uzKNxWg/KUTV+uFn/IRvuKL9qf4Vevh5yACVAUL0G67AEkboIGR2tMGp/iofvUz3V/tv/BI85W/tF8jkMNjf6oEEaHVQAlYDU7zVz6KNwIJCVRtcNoQTZi0gSnB0nxFyCp+af7Kp1pfdWCov8o/xYMv0lNABIAKfHW8FLDd61W/CKD9uweE8uu2d9crfx+vNc9+k54KYDXgR+Dmp7lLkLsJn/pP8ar61wmV+u8WgPwJr3QgyN8IJHzbdxXQrgHwasKMQP78/0o+7fcgIlzVXiVYlTCfnX86Uav1Cu+qPcVTJ6b88QRRQbrSpA1aTfgsrzSe6pM/NSD1342n4qeCEB7d+Vf5UK2Pb/MK4HcDpNpAAVrFQ/678VS+aT5VfNP9I5Dw3w+o4WkDqv7mBHlEoFvgI5ARyAPDugmmATAnyNqD5j7t4dXVia8J021PTwzFTwkqwgtP7Vd98i+Bp/Gr+HThPwK5dUKf+4hAr26o4lUJ2Y1HNZ8uwp/lceZ/BDIC+SNnRiD/XMFGICOQEch/hXDywfGyQHQHTY9QTSjZ0yuP8tMRXq0/rUf1pfmmrxFS/8JX9u78dAVVP377HEQFVAnS3XD5Uz1VAFP/aoj8aX9qV7wRSHjFGoE8PppTBJOAUzxTAYjgyl/70/wVb06QA0LVhouAasicIM8RGoEcThBNhFThKUGrhJXglI/2p/V3E6yaX5pPWq/wrdrT/DVA5e++f/nRo68GTAWkdjWoSsCqwHfnl+L16n6r/jT/EUj4gys1YATS++8PhHdqH4EcEEsBEcHVEO1PJ2qa/+780nzSepV/1Z7m//ITJA2YApISVICl8bVer9G0f7c9xU/5pPUqfpU/qWBTfvCDwt2AqCECOLUrXmpP8Un9V9d345PWq/gjEPyDHBFAAKd2xUvtKWFS/9X13fik9Sr+CGQEUuV4ab8IWr2iKDnF//ICEQC608ku/9125ZNOSOWXElD+jva0HhFWdhFa+af4pvkovvIXnvf9l7+sqIJ2E0YACYC0gYq3u960nrQ/wiOtT/5SAgt/2VM8RiDFK6EarIal9hFIitjj+hHIAb+UUDX4f/xIJ2waL60nJYQmflqf/GnApPuFZ4rHbyeIGqAEtF/26p1bgKf+q+vT/cJHdsVT/0Qg4av8qnblL/vV+MtPVtyVwJnftCA1UATShFQ+u/FJ46cTeATy56/ajEBuzB6BPH8MjgaQBFy1awDJfjX+CGQE8j8E5gTBCaIriBSqCaP9uhKogam9u17Vr/q0v4qf9lfxE55V/8JP/tP67+sv/xvoqwFXX3OIMFePzKvxVW+ar/zpyidCyn+abzUfEVj+RyD4XCIFWALqJlhKOBFYhOnOP8VX+Qt/2dP6lL/yPcN7TpAbcppQAngE8oiABCD72wlEBKkqNCVYdb0msOpVfOEhu/zLLv/V+lP/InxqV/2yq34J8L7/8m/SqwRTgVW7AKrmXyVQd30ioAiRnoDV+rW/Gx/5O8NvBCLkTuxqsOwXw35sk//qgEj9S6CpvRsf+RuBHBCaE+T5g/BGIHiyYlXxmmDVI1/7uxuseJpQusJof9oP1a94af+ET5pPGl8DT/54gnzXAu91VQkmfES4EUjtqyzCdwRy+JdtIqwmVmpXPDVwBDICeeCAjrSUcPJXPSG0P81XglE9ipcKXBO2KuBqvtX4qk94x1csNbgKiBqs+NovQKr5d+cngaYESNerHuElgiufdH/a/xTf3z4HSQESYNUClE/qX/5SAOUvza8aX/FEQNWjfsv/CCR8Vm7a0LQBc4Jkb+OOQMKvu1cBkwBkV3ztH4GMQP7NofSE5hVLDnXkVgkqgXTbuwW3G59ufNP6dWVSftX9wrfrxrH8bd60YK1PC+wWRBeAq3mlA0f4dOM7Anl8G/qO/wjkhkRKkFVhfACN12jy1y2w6oCongDV/Rog1fpGIAcERyDPP8gTPiJkldDpAFE+qwNn26NHVVBqV4NkF2BqYOo/rS9dryvWKgFWT7iqP+GvE6Ubn9V+j0BOkBchuhvaTQDlv0qQVQHJ3wik+Vm3KaDphK9O4BHIn1/Ungkq7Wc6MORf/spfNdFE2k0YCUD2FMDPrlcNrQpcE194pvGFfzd/lN9q/csPjlMBXQl1TSA1uJuAqT/hKX+yq/7UrnirhFvtrwSlfKoD7rcPCrscKvHVO60IlDZY/tKGVP2l+1dxva+r4pMOvBFI+NwqNbRbkFV/I5De/5P+6n50C3ROEChYEzQ9ATTRNVBSu+Kl9jT+txeIABHA6X6t3zUhzuKmDa4KSvtfXb/6kQ4I+eu2d/Fz+bE/uoKkgKWEeDVBRiDPKZv2u1sA8jcCCX9/IoFXBSjBi1DaX80vrV8EVD3av9s+AhmBPHAsJUQqSAl0N+FT/ykeZwNk+asmAqgbcBW4O161Xl3RUv9Vf+kJonivtlfzl8DO+DQCuSEnwYkQKeHT9dX4VYKlA0v5pvZq/iMQIXCwq0EpgXevr+ZbJdgIZDPB5F4EkF3+dxN4t/+0fr2Irp6YyqfbXhW4+NF+xVJAEUb7NbFSwBRP9irhdvuv5tdN6LR/6qfyE9+uDoTLr0HUcCWs/SnAAkDxZK8ScLf/an4iYLddeKj/6rfyFT/v/kcg6tTNXiWgwlT9d+9PCSpCKr85QcIfVKlBAlSETO1qsCaa4lX9d+8X/lW78Ej9r54IZ3HPBP5pTzVRQz8bQOUnQVQnakoQ5Ss8Xz1wlI/w694/AjkgqgaIcCMQUbRmV3/kPd0/AhmBiFMPdg2AyNmFxSnB54p1QCC9gqQAzgny/KEMFzgfbfnyAlEBVYIJTcXX/t2Cqean/bKn9QuP1J9OIOUv/iifdIC2X7GqBQpAAaD42i9CCGC9qK3mp/2yp/ULj9Sf+qv8RyD4n4NqiADWfhFiBPL83ycI3xHI5t9jqAEjkN6HLGhgqB86UeU/HUjKR/5W7W3PxUoT1vrU/i5H8j3v3fl0E7JKYJ0YX9X/COTWudWJciYA7U8Fn/oTQdMTV+tlV73aL/ur/I9ARiB/5JoIKvurCHwWR/nJ/jEIf91GjzZ0XxkEYGrvzi/FI534qi/1NyfII6LV/sUCUUPThHSHlr/0Tvvd8hc+sqf4aQClglb/d+e36n/5ivXdCLYK0OqLbhHk3Se8BDUC2fw/9KoAdxNsBFK7kugEUL+1f3d/Vv3PCXJDavcE7RZ4mm81vgivE1Q3kFfnVxZIWlAVQAEse5qv1u+uR/Gr9lfjJcJ11yN/GiDK947fy57Nq4ZV7QJME0qA6Uqghkhwyj+1C0/5S/FK8VN84a396ofyHYEAYRFaBJRdDa7aq/FHIP983X9OkBMmjkBqvwcRfukASAXbfoIo4WpA+U/tmpACtFqP/OsIr14hhJfqkz31r/WpXfhKgCk/zvBYfuxPCqgKSAEToar5pQ3R+hFIrcPCV/wagRx+TzICeSSk8JBd9BZBtV/2EYgQgj2dEJroaUO0XvF0Ihbh+SEByK74I5ADQgKkSlg1RISrxld9aX5ar3yr+1P/Wl8dCPKversHyuqAuPwaRAmvJpACc18v/7JLcFfzWt1XJYz2y767f8K/OpBSwarfZ/5GIDfkqg1bFcZ9XUrgKqFVn/JJCTkCOXSsG2ARLm2AGiwCKZ/ULrzkT/tlrwpO+aX9kT/lm+5Xfh83lfsPpq4eQWeJpYRLCVxdr/xEsN32lBCrDV/tV7W+lLCqN62vq79tD6+WwARYlfCKr4ZXG6QGpnblk9Yr/NP8UjwVX/UqP+Fx1f8I5KRzIsBuuxoqQmjgpPtFUE3sEcgBgRQwNVQNqjZchFT8brvySesVQXfnr/iqV/kJj6v+l08QFSiCq4Duiax8lU8KaLq+u14RKB1YqifFN12verr7F7/NmwI6Anls2WcLQPFTwqb9Tf2L8IovvgqPEQg6VgVYE1cT8dX2lMAiaOpP64WHBFXtx33/XLFuSIxAnlP2rxeICCJFvnoiVPPRBNKRrHqr++W/u/40nvgiQWl/mo/w0Il0Zm/7RaEKUoIirPyrIdqv/NKGjkCe/yIxxVP9G4EAoRFI7SeyKQFFcPVD+9N8RiAjkKcIiJBVwqUnvPL5cgLpBjD1J8B2A64rUWoXoVRPuj+9Iiq+/KX9VT06ARQv5c9qfctfd1eCVXtaYAq48ksFsArwPW66XvW9e77Cu9pv4SPBrfZjBHJD8t0Jp4ZW7SKcThwJQv5FaPlPBSe8Pgbb2dfdlVC3PS0wBVz5jkAeEVolkHA9s1f7nfY/7e9vAlHCV4E425cmrIbtzr+aryZkWp8muvyJYGm98pfyJ42f1qt87/Evfw6SFrybICOQ2gkggskuwqV8GYGEz7VSg0YgI5B/I6ATVoKeEyQcadWJtvsEXW346muCtF7FD+H+kcbXAFX8s/1t/0DnagJXG6aGpAAr/6q9u4FpPpqoOoG1v9oPDRDVW81/BFL8F3NqkOwjkMevwlQJLUGmghuBjECeang3YXWip4QegYSE1oSWXSdA1V6NLwIrP12R5F/7RdhvLxABqAkggsiuBoggyk/+1WARKMVP9Sie9qd4Cx/h212/6kv7Vb5ipQV2Jbj6Il6AqYEiQFqP/KX5pvnL/wjk+Wsivs0rQqgB2p/auwmnCSwCyd6d7whEjHu0p/yaE+SA7wjk5wMiwiMVvAia0T1frfir9uXPQd7tiqWGqeHVE6Dbf06Bxx3V/lTjV/erH59V3wjk1tluwqvhVUJpQMi/6tX+brvwGoGEb+uKICKAGvJq/1XCfRaBqnnf96sfn1XfnCBzgnRxvORnBIITIp0Q6oZOEO2XPW2oXhQqnuyvrjd9V039FT676zvD921PEBFC9t2AjkAeOyC8RyAHxqYTQQBKEOlES/2lr0lSAVXzEUGr/tUfxU/3C79qPav75wRZReqwTg1M7RfT+Ngmglb9pwTXQNFAE37Velb3Lwtk1eHpXa74GkQESAHV+m5CpCdqine1HsWr4r8bTwnyav4jkBuyIrAmXtogEVqErcZL/V8l2D3OCASIixDvBuDufIRHSmD5Uz2KNwIpflAngKsNrDaoe+JW8xEewrO7HsXrrrf7RE7xWF3/to/9EYCfTTBdyXYTSvisEmDXa0blp/7JLkGrfu2/928EckNKDana1TAJbrWhVwn/6vy68RQ+6RVzBHJAtNow7X81AdN46fqrhDt70a4BoRN5BBI+aE6AVQlRbagEVSVgWl+6vppfWv+nCyQl1KwfBP4GBN7m3x/8DWBPjV8Pgf8AkKUrmAjxSVQAAAAASUVORK5CYII="; readonly deprecated: false; }; readonly payload: { readonly type: "string"; readonly description: "Copy and Paste of the Pix QrCode"; readonly example: "00020101021226730014br.gov.bcb.pix2551pix-h.asaas.com/pixqrcode/cobv/pay_76575613967995145204000053039865802BR5905ASAAS6009Joinville61088922827162070503***63045E7A"; readonly deprecated: false; }; readonly expirationDate: { readonly type: "string"; readonly description: "QrCode expiration date"; readonly format: "date-time"; readonly example: "2022-06-24 23:59:59"; readonly deprecated: false; }; }; readonly description: "Payment data related to pix"; readonly deprecated: false; }; export declare const ApiBankSlipBillingInfoResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly identificationField: { readonly type: "string"; readonly description: "Digitable bill line"; readonly example: "00190000090275928800021932978170187890000005000"; readonly deprecated: false; }; readonly nossoNumero: { readonly type: "string"; readonly description: "Unique identification of the bank slip"; readonly example: "6543"; readonly deprecated: false; }; readonly barCode: { readonly type: "string"; readonly description: "Bank slip bar code"; readonly example: "00191878900000050000000002759288002193297817"; readonly deprecated: false; }; readonly bankSlipUrl: { readonly type: "string"; readonly description: "URL to download the bank slip"; readonly example: "https://www.asaas.com/b/pdf/080225913252"; readonly deprecated: false; }; readonly daysAfterDueDateToRegistrationCancellation: { readonly type: "integer"; readonly description: "Days after registration cancellation deadline (only for bank slip)"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; }; readonly description: "Payment data related to bank slip"; readonly deprecated: false; }; export declare const ApiPaymentLimitsResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly creation: { readonly $ref: "#/components/schemas/ApiPaymentLimitsResponseCreationDTO"; }; }; }; export declare const ApiPaymentLimitsResponseCreationDTOSchema: { readonly type: "object"; readonly properties: { readonly daily: { readonly $ref: "#/components/schemas/ApiPaymentLimitsResponseCreationDailyDTO"; }; }; readonly description: "Breeding limits"; readonly deprecated: false; }; export declare const ApiPaymentLimitsResponseCreationDailyDTOSchema: { readonly type: "object"; readonly properties: { readonly limit: { readonly type: "integer"; readonly description: "Total limit"; readonly format: "int64"; readonly example: 10; readonly deprecated: false; }; readonly used: { readonly type: "integer"; readonly description: "Limit used"; readonly format: "int64"; readonly example: 5; readonly deprecated: false; }; readonly wasReached: { readonly type: "boolean"; readonly description: "Indicates whether the limit has been reached"; readonly deprecated: false; readonly example: null; }; }; readonly description: "Daily limits"; readonly deprecated: false; }; export declare const ApiPaymentRefundRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Amount to be refunded"; readonly example: 5; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Reason for the refund"; readonly example: "Valor a mais"; readonly deprecated: false; }; }; }; export declare const ApiPaymentStatusResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly status: { readonly $ref: "#/components/schemas/ApiPaymentStatusResponsePaymentStatus"; }; }; }; export declare const ApiPaymentStatusResponsePaymentStatusSchema: { readonly type: "string"; readonly description: "Payment status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE", "REFUNDED", "RECEIVED_IN_CASH", "REFUND_REQUESTED", "REFUND_IN_PROGRESS", "CHARGEBACK_REQUESTED", "CHARGEBACK_DISPUTE", "AWAITING_CHARGEBACK_REVERSAL", "DUNNING_REQUESTED", "DUNNING_RECEIVED", "AWAITING_RISK_ANALYSIS"]; }; export declare const ApiPaymentDocumentSaveRequestDTOSchema: { readonly required: readonly ["availableAfterPayment", "type"]; readonly type: "object"; readonly properties: { readonly availableAfterPayment: { readonly required: readonly ["availableAfterPayment"]; readonly type: "boolean"; readonly description: "true to make the file available only after receipt of the payment"; readonly example: true; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDocumentSaveRequestPaymentDocumentType"; }; readonly file: { readonly $ref: "#/components/schemas/File"; }; }; }; export declare const ApiPaymentDocumentSaveRequestPaymentDocumentTypeSchema: { readonly required: readonly ["type"]; readonly type: "string"; readonly description: "Document type"; readonly example: "INVOICE"; readonly deprecated: false; readonly enum: readonly ["INVOICE", "CONTRACT", "MEDIA", "DOCUMENT", "SPREADSHEET", "PROGRAM", "OTHER"]; }; export declare const ApiPaymentDocumentGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "paymentDocument"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique document identifier"; readonly example: "609a3f98-8db7-4a89-b511-de4c3be6d462"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Document name"; readonly example: "Nota Fiscal.pdf"; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDocumentGetResponsePaymentDocumentType"; }; readonly availableAfterPayment: { readonly type: "boolean"; readonly description: "Available only after payment"; readonly example: true; readonly deprecated: false; }; readonly file: { readonly $ref: "#/components/schemas/ApiPaymentDocumentFileResponseDTO"; }; readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the file was removed"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiPaymentDocumentGetResponsePaymentDocumentTypeSchema: { readonly type: "string"; readonly description: "Document type"; readonly example: "INVOICE"; readonly deprecated: false; readonly enum: readonly ["INVOICE", "CONTRACT", "MEDIA", "DOCUMENT", "SPREADSHEET", "PROGRAM", "OTHER"]; }; export declare const ApiPaymentDocumentFileResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly publicId: { readonly type: "string"; readonly description: "Unique document identifier"; readonly example: "TSrLvzPGF7HPQhYu9OZhZSBX3mm1sxpToEcFm30imOM3sKEjhzCc1zAIuqQ7n11"; readonly deprecated: false; }; readonly originalName: { readonly type: "string"; readonly description: "Original document name"; readonly example: "Nota Fiscal.pdf"; readonly deprecated: false; }; readonly size: { readonly type: "integer"; readonly description: "File size"; readonly format: "int32"; readonly example: 14499; readonly deprecated: false; }; readonly extension: { readonly type: "string"; readonly description: "File extension"; readonly example: "pdf"; readonly deprecated: false; }; readonly previewUrl: { readonly type: "string"; readonly description: "Link to download the file preview"; readonly example: "https://www.asaas.com/file/preview/TSrLvzPGF7HPQhYu9OZhZSBX3mm1sxpToEcFm30imOM3sKEjhzCc1zAIuqQ7n11"; readonly deprecated: false; }; readonly downloadUrl: { readonly type: "string"; readonly description: "Link to download the file"; readonly example: "https://www.asaas.com/file/public/download/TSrLvzPGF7HPQhYu9OZhZSBX3mm1sxpToEcFm30imOM3sKEjhzCc1zAIuqQ7n11"; readonly deprecated: false; }; }; readonly description: "File object"; readonly deprecated: false; }; export declare const ApiPaymentDocumentUpdateRequestDTOSchema: { readonly required: readonly ["id", "documentId", "availableAfterPayment", "type"]; readonly type: "object"; readonly properties: { readonly availableAfterPayment: { readonly required: readonly ["availableAfterPayment"]; readonly type: "boolean"; readonly description: "true to make the file available only after receipt of the payment"; readonly example: true; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDocumentUpdateRequestPaymentDocumentType"; }; }; }; export declare const ApiPaymentDocumentUpdateRequestPaymentDocumentTypeSchema: { readonly required: readonly ["type"]; readonly type: "string"; readonly description: "Document type"; readonly example: "INVOICE"; readonly deprecated: false; readonly enum: readonly ["INVOICE", "CONTRACT", "MEDIA", "DOCUMENT", "SPREADSHEET", "PROGRAM", "OTHER"]; }; export declare const ApiPaymentDocumentListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentDocumentGetResponseDTO"; }; }; }; }; export declare const ApiPaymentDocumentDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the file was removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique document identifier"; readonly example: "609a3f98-8db7-4a89-b511-de4c3be6d462"; readonly deprecated: false; }; }; }; export declare const ApiPaymentDunningCancelRequestDTOSchema: { readonly required: readonly ["id"]; readonly type: "object"; readonly properties: {}; }; export declare const ApiPaymentDunningCancelResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique identifier of the payment dunning in Asaas"; readonly example: "ce35702d-0d9f-475a-ba46-e251ad265c91"; readonly deprecated: false; }; readonly dunningNumber: { readonly type: "integer"; readonly description: "Payment dunning number"; readonly format: "int32"; readonly example: 15; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentDunningCancelResponsePaymentDunningStatus"; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningCancelResponsePaymentDunningType"; }; readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be recovered in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; readonly requestDate: { readonly type: "string"; readonly description: "Request date"; readonly format: "date"; readonly example: "2020-05-26"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Description of the payment dunning"; readonly example: "Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 80; readonly deprecated: false; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 8; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 72; readonly deprecated: false; }; readonly receivedInCashFeeValue: { readonly type: "number"; readonly description: "Cash receipt fee"; readonly example: 0; readonly deprecated: false; }; readonly denialReason: { readonly type: "string"; readonly description: "Reason for denial of payment dunning"; readonly deprecated: false; readonly example: null; }; readonly cancellationFeeValue: { readonly type: "number"; readonly description: "Fee charged in case of cancellation"; readonly example: 0; readonly deprecated: false; }; readonly canBeCancelled: { readonly type: "boolean"; readonly description: "Whether the payment dunning can be canceled"; readonly deprecated: false; readonly default: true; readonly example: null; }; readonly cannotBeCancelledReason: { readonly type: "string"; readonly description: "Reason for not being able to request cancellation"; readonly deprecated: false; readonly example: null; }; readonly isNecessaryResendDocumentation: { readonly type: "boolean"; readonly description: "Determine whether documentation needs to be resubmitted"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentDunningCancelResponsePaymentDunningStatusSchema: { readonly type: "string"; readonly description: "Payment dunning status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_APPROVAL", "AWAITING_CANCELLATION", "PROCESSED", "PAID", "PARTIALLY_PAID", "DENIED", "CANCELLED"]; }; export declare const ApiPaymentDunningCancelResponsePaymentDunningTypeSchema: { readonly type: "string"; readonly description: "Type of payment dunning"; readonly example: "CREDIT_BUREAU"; readonly deprecated: false; readonly enum: readonly ["CREDIT_BUREAU"]; }; export declare const ApiPaymentDunningSaveDocumentsRequestDTOSchema: { readonly required: readonly ["id", "documents"]; readonly type: "object"; readonly properties: { readonly documents: { readonly required: readonly ["documents"]; readonly type: "string"; readonly description: "Invoice and/or contract notarized"; readonly format: "binary"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentDunningSaveDocumentsResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique identifier of the payment dunning in Asaas"; readonly example: "ce35702d-0d9f-475a-ba46-e251ad265c91"; readonly deprecated: false; }; readonly dunningNumber: { readonly type: "integer"; readonly description: "Payment dunning number"; readonly format: "int32"; readonly example: 15; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentDunningSaveDocumentsResponsePaymentDunningStatus"; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningSaveDocumentsResponsePaymentDunningType"; }; readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be recovered in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; readonly requestDate: { readonly type: "string"; readonly description: "Request date"; readonly format: "date"; readonly example: "2020-05-26"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Description of the payment dunning"; readonly example: "Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 80; readonly deprecated: false; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 8; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 72; readonly deprecated: false; }; readonly receivedInCashFeeValue: { readonly type: "number"; readonly description: "Cash receipt fee"; readonly example: 0; readonly deprecated: false; }; readonly denialReason: { readonly type: "string"; readonly description: "Reason for denial of payment dunning"; readonly deprecated: false; readonly example: null; }; readonly cancellationFeeValue: { readonly type: "number"; readonly description: "Fee charged in case of cancellation"; readonly example: 0; readonly deprecated: false; }; readonly canBeCancelled: { readonly type: "boolean"; readonly description: "Whether the payment dunning can be canceled"; readonly deprecated: false; readonly default: true; readonly example: null; }; readonly cannotBeCancelledReason: { readonly type: "string"; readonly description: "Reason for not being able to request cancellation"; readonly deprecated: false; readonly example: null; }; readonly isNecessaryResendDocumentation: { readonly type: "boolean"; readonly description: "Determine whether documentation needs to be resubmitted"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentDunningSaveDocumentsResponsePaymentDunningStatusSchema: { readonly type: "string"; readonly description: "Payment dunning status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_APPROVAL", "AWAITING_CANCELLATION", "PROCESSED", "PAID", "PARTIALLY_PAID", "DENIED", "CANCELLED"]; }; export declare const ApiPaymentDunningSaveDocumentsResponsePaymentDunningTypeSchema: { readonly type: "string"; readonly description: "Type of payment dunning"; readonly example: "CREDIT_BUREAU"; readonly deprecated: false; readonly enum: readonly ["CREDIT_BUREAU"]; }; export declare const ApiPaymentDunningPaymentsAvailableForDunningResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly example: readonly [{ readonly payment: "pay_856437540297"; readonly customer: "cus_000000001663"; readonly value: 250; readonly status: "PENDING"; readonly billingType: "BOLETO"; readonly dueDate: "2020-05-18"; readonly typeSimulations: readonly [{ readonly type: "CREDIT_BUREAU"; readonly isAllowed: true; readonly feeValue: 0; readonly netValue: 0; readonly startDate: "2020-05-18"; }, { readonly type: "CREDIT_BUREAU"; readonly isAllowed: false; readonly notAllowedReason: "A negativação via Serasa não está disponível para parcelamentos de cartão de crédito."; readonly feeValue: 0; readonly netValue: 0; }]; }, { readonly payment: "pay_4272418031993158"; readonly customer: "cus_000000001838"; readonly value: 23; readonly status: "OVERDUE"; readonly billingType: "CREDIT_CARD"; readonly dueDate: "2020-08-12"; readonly typeSimulations: readonly [{ readonly type: "CREDIT_BUREAU"; readonly isAllowed: true; readonly feeValue: 0; readonly netValue: 0; readonly startDate: "2020-05-18"; }, { readonly type: "CREDIT_BUREAU"; readonly isAllowed: false; readonly notAllowedReason: "A negativação via Serasa não está disponível para parcelamentos de cartão de crédito."; readonly feeValue: 0; readonly netValue: 0; }]; }, { readonly payment: "pay_4311673768874477"; readonly customer: "cus_000000001342"; readonly value: 23; readonly status: "OVERDUE"; readonly billingType: "CREDIT_CARD"; readonly dueDate: "2022-12-19"; readonly typeSimulations: readonly [{ readonly type: "CREDIT_BUREAU"; readonly isAllowed: true; readonly feeValue: 0; readonly netValue: 0; readonly startDate: "2020-05-18"; }, { readonly type: "CREDIT_BUREAU"; readonly isAllowed: false; readonly notAllowedReason: "A negativação via Serasa não está disponível para parcelamentos de cartão de crédito."; readonly feeValue: 0; readonly netValue: 0; }]; }]; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be recovered in Asaas"; readonly example: "pay_856437540297"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000000001663"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 250; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentDunningPaymentsAvailableForDunningResponseDataPaymentStatus"; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentDunningPaymentsAvailableForDunningResponseDataBillingType"; }; readonly dueDate: { readonly type: "string"; readonly description: "Due date"; readonly example: "2020-05-18"; readonly deprecated: false; }; readonly typeSimulations: { readonly type: "array"; readonly description: "Simulation of denial request for each type of payment dunning available"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningType"; }; readonly isAllowed: { readonly type: "boolean"; readonly description: "Whether it is possible to request a payment dunning of this type"; readonly deprecated: false; readonly default: true; readonly example: null; }; readonly notAllowedReason: { readonly type: "string"; readonly description: "Reason why it is not possible to request a payment dunning for this type"; readonly deprecated: false; readonly example: null; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 0; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 0; readonly deprecated: false; }; readonly startDate: { readonly type: "string"; readonly description: "Expected start date of the payment dunning"; readonly example: "2020-05-27"; readonly deprecated: false; }; }; }; }; }; }; }; }; }; export declare const ApiPaymentDunningPaymentsAvailableForDunningResponseDataDTOSchema: { readonly type: "object"; readonly properties: { readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be recovered in Asaas"; readonly example: "pay_856437540297"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_000000001663"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 250; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentDunningPaymentsAvailableForDunningResponseDataPaymentStatus"; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentDunningPaymentsAvailableForDunningResponseDataBillingType"; }; readonly dueDate: { readonly type: "string"; readonly description: "Due date"; readonly example: "2020-05-18"; readonly deprecated: false; }; readonly typeSimulations: { readonly type: "array"; readonly description: "Simulation of denial request for each type of payment dunning available"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningType"; }; readonly isAllowed: { readonly type: "boolean"; readonly description: "Whether it is possible to request a payment dunning of this type"; readonly deprecated: false; readonly default: true; readonly example: null; }; readonly notAllowedReason: { readonly type: "string"; readonly description: "Reason why it is not possible to request a payment dunning for this type"; readonly deprecated: false; readonly example: null; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 0; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 0; readonly deprecated: false; }; readonly startDate: { readonly type: "string"; readonly description: "Expected start date of the payment dunning"; readonly example: "2020-05-27"; readonly deprecated: false; }; }; }; }; }; }; export declare const ApiPaymentDunningPaymentsAvailableForDunningResponseDataPaymentStatusSchema: { readonly type: "string"; readonly description: "Billing status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE"]; }; export declare const ApiPaymentDunningPaymentsAvailableForDunningResponseDataBillingTypeSchema: { readonly type: "string"; readonly description: "Form of payment"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["BOLETO", "CREDIT_CARD", "TRANSFER", "DEPOSIT", "DEBIT_CARD", "PIX"]; }; export declare const ApiPaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemDTOSchema: { readonly type: "object"; readonly properties: { readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningType"; }; readonly isAllowed: { readonly type: "boolean"; readonly description: "Whether it is possible to request a payment dunning of this type"; readonly deprecated: false; readonly default: true; readonly example: null; }; readonly notAllowedReason: { readonly type: "string"; readonly description: "Reason why it is not possible to request a payment dunning for this type"; readonly deprecated: false; readonly example: null; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 0; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 0; readonly deprecated: false; }; readonly startDate: { readonly type: "string"; readonly description: "Expected start date of the payment dunning"; readonly example: "2020-05-27"; readonly deprecated: false; }; }; }; export declare const ApiPaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningTypeSchema: { readonly type: "string"; readonly description: "Type of payment dunning"; readonly example: "CREDIT_BUREAU"; readonly deprecated: false; readonly enum: readonly ["CREDIT_BUREAU"]; }; export declare const ApiPaymentDunningListPartialPaymentsResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly example: readonly [{ readonly value: 800; readonly description: "A quitação desta cobrança foi efetuada pelo cliente."; readonly paymentDate: "2020-02-10"; }, { readonly value: 800; readonly description: "Pagamento parcial efetuado pelo cliente. Há pagamentos pendentes para a quitação dessa cobrança."; readonly paymentDate: "2020-01-10"; }, { readonly value: 800; readonly description: "A quitação desta cobrança foi efetuada pelo cliente."; readonly paymentDate: "2019-12-10"; }]; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Amount paid"; readonly example: 800; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payment Description"; readonly example: "A quitação desta cobrança foi efetuada pelo cliente."; readonly deprecated: false; }; readonly paymentDate: { readonly type: "string"; readonly description: "Pay day"; readonly example: "2020-02-10"; readonly deprecated: false; }; }; }; }; }; }; export declare const ApiPaymentDunningListPartialPaymentsResponseDataDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Amount paid"; readonly example: 800; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payment Description"; readonly example: "A quitação desta cobrança foi efetuada pelo cliente."; readonly deprecated: false; }; readonly paymentDate: { readonly type: "string"; readonly description: "Pay day"; readonly example: "2020-02-10"; readonly deprecated: false; }; }; }; export declare const ApiPaymentDunningShowResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique identifier of the payment dunning in Asaas"; readonly example: "ce35702d-0d9f-475a-ba46-e251ad265c91"; readonly deprecated: false; }; readonly dunningNumber: { readonly type: "integer"; readonly description: "Payment dunning number"; readonly format: "int32"; readonly example: 15; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentDunningShowResponsePaymentDunningStatus"; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningShowResponsePaymentDunningType"; }; readonly requestDate: { readonly type: "string"; readonly description: "Request date"; readonly format: "date"; readonly example: "2020-05-26"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Description of the payment dunning"; readonly example: "Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 80; readonly deprecated: false; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 8; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 72; readonly deprecated: false; }; readonly receivedInCashFeeValue: { readonly type: "number"; readonly description: "Cash receipt fee"; readonly example: 0; readonly deprecated: false; }; readonly denialReason: { readonly type: "string"; readonly description: "Reason for denial of payment dunning"; readonly deprecated: false; readonly example: null; }; readonly cancellationFeeValue: { readonly type: "number"; readonly description: "Fee charged in case of cancellation"; readonly example: 0; readonly deprecated: false; }; readonly canBeCancelled: { readonly type: "boolean"; readonly description: "Whether the payment dunning can be canceled"; readonly deprecated: false; readonly default: true; readonly example: null; }; readonly cannotBeCancelledReason: { readonly type: "string"; readonly description: "Reason for not being able to request cancellation"; readonly deprecated: false; readonly example: null; }; readonly isNecessaryResendDocumentation: { readonly type: "boolean"; readonly description: "Determine whether documentation needs to be resubmitted"; readonly deprecated: false; readonly example: null; }; readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be recovered in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; }; }; export declare const ApiPaymentDunningShowResponsePaymentDunningStatusSchema: { readonly type: "string"; readonly description: "Payment dunning status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_APPROVAL", "AWAITING_CANCELLATION", "PROCESSED", "PAID", "PARTIALLY_PAID", "DENIED", "CANCELLED"]; }; export declare const ApiPaymentDunningShowResponsePaymentDunningTypeSchema: { readonly type: "string"; readonly description: "Type of payment dunning"; readonly example: "CREDIT_BUREAU"; readonly deprecated: false; readonly enum: readonly ["CREDIT_BUREAU"]; }; export declare const ApiPaymentDunningSaveRequestDTOSchema: { readonly required: readonly ["payment", "type", "customerName", "customerCpfCnpj", "customerPrimaryPhone", "customerPostalCode", "customerAddress", "customerAddressNumber", "customerProvince"]; readonly type: "object"; readonly properties: { readonly payment: { readonly required: readonly ["payment"]; readonly type: "string"; readonly description: "Unique identifier of the payment to be recovered in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningSaveRequestPaymentDunningType"; }; readonly description: { readonly type: "string"; readonly description: "Description of the product or service provided"; readonly example: "Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018"; readonly deprecated: false; }; readonly customerName: { readonly required: readonly ["customerName"]; readonly type: "string"; readonly description: "Client name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly customerCpfCnpj: { readonly required: readonly ["customerCpfCnpj"]; readonly type: "string"; readonly description: "Customer CPF or CNPJ"; readonly example: "378.285.120-07"; readonly deprecated: false; }; readonly customerPrimaryPhone: { readonly required: readonly ["customerPrimaryPhone"]; readonly type: "string"; readonly description: "Customer main telephone number"; readonly example: "(11) 99999-9999"; readonly deprecated: false; }; readonly customerSecondaryPhone: { readonly type: "string"; readonly description: "Secondary customer phone number"; readonly example: "(11) 99999-9999"; readonly deprecated: false; }; readonly customerPostalCode: { readonly required: readonly ["customerPostalCode"]; readonly type: "string"; readonly description: "Customer address zip code"; readonly example: "99050-460"; readonly deprecated: false; }; readonly customerAddress: { readonly required: readonly ["customerAddress"]; readonly type: "string"; readonly description: "Customer public address"; readonly example: "Rua Izaías Fontana"; readonly deprecated: false; }; readonly customerAddressNumber: { readonly required: readonly ["customerAddressNumber"]; readonly type: "string"; readonly description: "Customer address number"; readonly example: "123"; readonly deprecated: false; }; readonly customerComplement: { readonly type: "string"; readonly description: "Customer address complement"; readonly example: "AP 101"; readonly deprecated: false; }; readonly customerProvince: { readonly required: readonly ["customerProvince"]; readonly type: "string"; readonly description: "Customer neighborhood"; readonly example: "Petrópolis"; readonly deprecated: false; }; readonly documents: { readonly type: "string"; readonly description: "Invoice and/or contract notarized"; readonly format: "binary"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentDunningSaveRequestPaymentDunningTypeSchema: { readonly required: readonly ["type"]; readonly type: "string"; readonly description: "Type of payment dunning"; readonly example: "CREDIT_BUREAU"; readonly deprecated: false; readonly enum: readonly ["CREDIT_BUREAU"]; }; export declare const ApiPaymentDunningListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentDunningShowResponseDTO"; }; }; }; }; export declare const ApiPaymentDunningListRequestPaymentDunningStatusSchema: { readonly type: "string"; readonly description: "Filter by payment dunning status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_APPROVAL", "AWAITING_CANCELLATION", "PROCESSED", "PAID", "PARTIALLY_PAID", "DENIED", "CANCELLED"]; }; export declare const ApiPaymentDunningListRequestPaymentDunningTypeSchema: { readonly type: "string"; readonly description: "Filter by type of payment dunning"; readonly example: "CREDIT_BUREAU"; readonly deprecated: false; readonly enum: readonly ["CREDIT_BUREAU", "DEBT_RECOVERY_ASSISTANCE"]; }; export declare const ApiPaymentDunningSimulateRequestDTOSchema: { readonly required: readonly ["payment"]; readonly type: "object"; readonly properties: {}; }; export declare const ApiPaymentDunningSimulateResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be recovered in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 80; readonly deprecated: false; }; readonly typeSimulations: { readonly type: "array"; readonly description: "Simulation of denial request for each type of denial available"; readonly example: readonly [{ readonly type: "CREDIT_BUREAU"; readonly isAllowed: true; readonly feeValue: 0; readonly netValue: 0; readonly startDate: "2020-05-18"; }, { readonly type: "CREDIT_BUREAU"; readonly isAllowed: false; readonly notAllowedReason: "A negativação via Serasa não está disponível para parcelamentos de cartão de crédito."; readonly feeValue: 0; readonly netValue: 0; }]; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningSimulateResponseTypeSimulationItemPaymentDunningType"; }; readonly isAllowed: { readonly type: "boolean"; readonly description: "Whether it is possible to request a payment dunning of this type"; readonly deprecated: false; readonly example: null; }; readonly notAllowedReason: { readonly type: "string"; readonly description: "Reason why it is not possible to request a payment dunning for this type"; readonly example: "A negativação via Serasa não está disponível para parcelamentos de cartão de crédito."; readonly deprecated: false; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 0; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 0; readonly deprecated: false; }; readonly startDate: { readonly type: "string"; readonly description: "Expected start date of the payment dunning"; readonly deprecated: false; readonly example: null; }; }; }; }; }; }; export declare const ApiPaymentDunningSimulateResponseTypeSimulationItemDTOSchema: { readonly type: "object"; readonly properties: { readonly type: { readonly $ref: "#/components/schemas/ApiPaymentDunningSimulateResponseTypeSimulationItemPaymentDunningType"; }; readonly isAllowed: { readonly type: "boolean"; readonly description: "Whether it is possible to request a payment dunning of this type"; readonly deprecated: false; readonly example: null; }; readonly notAllowedReason: { readonly type: "string"; readonly description: "Reason why it is not possible to request a payment dunning for this type"; readonly example: "A negativação via Serasa não está disponível para parcelamentos de cartão de crédito."; readonly deprecated: false; }; readonly feeValue: { readonly type: "number"; readonly description: "Cost and/or payment dunning fee"; readonly example: 0; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net amount to be recovered"; readonly example: 0; readonly deprecated: false; }; readonly startDate: { readonly type: "string"; readonly description: "Expected start date of the payment dunning"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentDunningSimulateResponseTypeSimulationItemPaymentDunningTypeSchema: { readonly type: "string"; readonly description: "Type of payment dunning"; readonly example: "CREDIT_BUREAU"; readonly deprecated: false; readonly enum: readonly ["CREDIT_BUREAU"]; }; export declare const ApiPaymentDunningListHistoryResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly status: { readonly $ref: "#/components/schemas/ApiPaymentDunningListHistoryResponseDataPaymentDunningHistoryStatus"; }; readonly description: { readonly type: "string"; readonly description: "Description of the event"; readonly example: "Negativação negociada com o cliente. O pagamento será iniciado."; readonly deprecated: false; }; readonly eventDate: { readonly type: "string"; readonly description: "Date the event occurred"; readonly example: "2019-02-20"; readonly deprecated: false; }; }; }; }; }; }; export declare const ApiPaymentDunningListHistoryResponseDataDTOSchema: { readonly type: "object"; readonly properties: { readonly status: { readonly $ref: "#/components/schemas/ApiPaymentDunningListHistoryResponseDataPaymentDunningHistoryStatus"; }; readonly description: { readonly type: "string"; readonly description: "Description of the event"; readonly example: "Negativação negociada com o cliente. O pagamento será iniciado."; readonly deprecated: false; }; readonly eventDate: { readonly type: "string"; readonly description: "Date the event occurred"; readonly example: "2019-02-20"; readonly deprecated: false; }; }; }; export declare const ApiPaymentDunningListHistoryResponseDataPaymentDunningHistoryStatusSchema: { readonly type: "string"; readonly description: "Negotiation status"; readonly example: "NEGOTIATED"; readonly deprecated: false; readonly enum: readonly ["IN_NEGOTIATION", "NEGOTIATION_FAIL", "NEGOTIATED", "PAID"]; }; export declare const ApiPaymentRefundListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentRefundGetResponseDTO"; }; }; }; }; export declare const ApiPaymentBankSlipRefundResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly requestUrl: { readonly type: "string"; readonly description: "Link to report refund details"; readonly example: "https://sandbox.asaas.com/solicitar-estorno/37ij5mdxwo1234"; readonly deprecated: false; }; }; }; export declare const ApiPaymentSimulateRequestDTOSchema: { readonly required: readonly ["value", "billingTypes"]; readonly type: "object"; readonly properties: { readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Total installment or billing amount"; readonly example: 100; readonly deprecated: false; }; readonly installmentCount: { readonly type: "integer"; readonly description: "Number of installments"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly billingTypes: { readonly required: readonly ["billingTypes"]; readonly type: "array"; readonly description: "Form of payment"; readonly example: readonly ["CREDIT_CARD", "BOLETO", "PIX"]; readonly deprecated: false; readonly items: { readonly type: "string"; }; }; }; }; export declare const ApiPaymentSimulateRequestBillingTypeSchema: { readonly type: "string"; }; export declare const ApiPaymentSimulateResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly type: "number"; readonly description: "Total installment or billing amount"; readonly example: 100; readonly deprecated: false; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiPaymentSimulateCreditCardResponseDTO"; }; readonly bankSlip: { readonly $ref: "#/components/schemas/ApiPaymentSimulateBankSlipResponseDTO"; }; readonly pix: { readonly $ref: "#/components/schemas/ApiPaymentSimulatePixResponseDTO"; }; }; }; export declare const ApiPaymentSimulateCreditCardResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly netValue: { readonly type: "number"; readonly description: "Net value"; readonly example: 100; readonly deprecated: false; }; readonly feePercentage: { readonly type: "number"; readonly description: "Rate in percentage"; readonly example: 2.49; readonly deprecated: false; }; readonly operationFee: { readonly type: "number"; readonly description: "Operation fee"; readonly example: 0.49; readonly deprecated: false; }; readonly installment: { readonly $ref: "#/components/schemas/ApiPaymentSimulateInstallmentResponseDTO"; }; }; readonly description: "Card fees"; readonly deprecated: false; }; export declare const ApiPaymentSimulateInstallmentResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly paymentNetValue: { readonly type: "number"; readonly description: "Net value"; readonly example: 48.52; readonly deprecated: false; }; readonly paymentValue: { readonly type: "number"; readonly description: "Total value"; readonly example: 50; readonly deprecated: false; }; }; readonly description: "Installment information"; readonly deprecated: false; }; export declare const ApiPaymentSimulateBankSlipResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly netValue: { readonly type: "number"; readonly description: "Net value"; readonly example: 98.02; readonly deprecated: false; }; readonly feeValue: { readonly type: "number"; readonly description: "Fee value"; readonly example: 0.99; readonly deprecated: false; }; readonly installment: { readonly $ref: "#/components/schemas/ApiPaymentSimulateInstallmentResponseDTO"; }; }; readonly description: "Boleto fees"; readonly deprecated: false; }; export declare const ApiPaymentSimulatePixResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly netValue: { readonly type: "number"; readonly description: "Net value"; readonly example: 98.02; readonly deprecated: false; }; readonly feePercentage: { readonly type: "number"; readonly description: "Rate in percentage"; readonly deprecated: false; readonly example: null; }; readonly feeValue: { readonly type: "number"; readonly description: "Fee value"; readonly example: 0.99; readonly deprecated: false; }; readonly installment: { readonly $ref: "#/components/schemas/ApiPaymentSimulateInstallmentResponseDTO"; }; }; readonly description: "PIX fees"; readonly deprecated: false; }; export declare const ApiPaymentSplitListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentSplitGetResponseDTO"; }; }; }; }; export declare const ApiPaymentSplitListPaidRequestPaymentSplitStatusSchema: { readonly type: "string"; readonly description: "Filter by status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_CREDIT", "CANCELLED", "DONE", "REFUNDED", "BLOCKED_BY_VALUE_DIVERGENCE"]; }; export declare const ApiPaymentSplitListReceivedRequestPaymentSplitStatusSchema: { readonly type: "string"; readonly description: "Filter by status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "AWAITING_CREDIT", "CANCELLED", "DONE", "REFUNDED", "BLOCKED_BY_VALUE_DIVERGENCE"]; }; export declare const ApiPaymentViewingInfoResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly invoiceViewedDate: { readonly type: "string"; readonly description: "Invoice viewing date and time"; readonly format: "date-time"; readonly example: "2017-06-10 11:00:00"; readonly deprecated: false; }; readonly boletoViewedDate: { readonly type: "string"; readonly description: "Bill viewing date and time"; readonly format: "date-time"; readonly example: "2017-06-10 11:00:00"; readonly deprecated: false; }; }; }; export declare const ApiPushNotificationConfigGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique Webhook Identifier"; readonly example: "bbf67496-1379-4b6d-a348-fd5fa229f1c"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Webhook name"; readonly example: "Name Example"; readonly deprecated: false; }; readonly url: { readonly type: "string"; readonly description: "Webhook URL"; readonly example: "https://www.exemplo.com/webhook/asaas"; readonly deprecated: false; }; readonly email: { readonly type: "string"; readonly description: "Email that will receive notifications about the Webhook"; readonly example: "john.doe@asaas.com.br"; readonly deprecated: false; }; readonly enabled: { readonly type: "boolean"; readonly description: "Set whether the Webhook is active"; readonly example: true; readonly deprecated: false; }; readonly interrupted: { readonly type: "boolean"; readonly description: "Set whether the sync queue is stopped"; readonly example: false; readonly deprecated: false; }; readonly apiVersion: { readonly type: "integer"; readonly description: "API Version"; readonly format: "int32"; readonly example: 3; readonly deprecated: false; }; readonly authToken: { readonly type: "string"; readonly description: "Webhook authentication token"; readonly example: "5tLxsL6uoN"; readonly deprecated: false; }; readonly sendType: { readonly $ref: "#/components/schemas/ApiPushNotificationConfigGetResponsePushNotificationSendType"; }; readonly events: { readonly type: "array"; readonly description: "List of events this Webhook will observe"; readonly example: readonly ["PAYMENT_RECEIVED", "PAYMENT_CONFIRMED"]; readonly deprecated: false; readonly items: { readonly type: "string"; }; }; }; }; export declare const ApiPushNotificationConfigGetResponsePushNotificationSendTypeSchema: { readonly type: "string"; readonly description: "Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)"; readonly example: "SEQUENTIALLY"; readonly deprecated: false; readonly enum: readonly ["NON_SEQUENTIALLY", "SEQUENTIALLY"]; }; export declare const ApiPushNotificationConfigGetResponsePushNotificationRequestEventSchema: { readonly type: "string"; }; export declare const ApiPushNotificationConfigUpdateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Webhook name"; readonly example: "Name Example"; readonly deprecated: false; }; readonly url: { readonly type: "string"; readonly description: "Event destination URL"; readonly example: "https://www.exemplo.com/webhook/asaas"; readonly deprecated: false; }; readonly sendType: { readonly $ref: "#/components/schemas/ApiPushNotificationConfigUpdateRequestPushNotificationSendType"; }; readonly enabled: { readonly type: "boolean"; readonly description: "Set whether the Webhook is active"; readonly example: true; readonly deprecated: false; }; readonly interrupted: { readonly type: "boolean"; readonly description: "Set whether the sync queue is stopped"; readonly example: false; readonly deprecated: false; }; readonly authToken: { readonly type: "string"; readonly description: "Webhook authentication token"; readonly example: "5tLxsL6uoN"; readonly deprecated: false; }; readonly events: { readonly type: "array"; readonly description: "List of events this Webhook will observe"; readonly example: readonly ["PAYMENT_RECEIVED", "PAYMENT_CONFIRMED"]; readonly deprecated: false; readonly items: { readonly type: "string"; }; }; }; }; export declare const ApiPushNotificationConfigUpdateRequestPushNotificationSendTypeSchema: { readonly type: "string"; readonly description: "Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)"; readonly example: "SEQUENTIALLY"; readonly deprecated: false; readonly enum: readonly ["NON_SEQUENTIALLY", "SEQUENTIALLY"]; }; export declare const ApiPushNotificationConfigUpdateRequestPushNotificationRequestEventSchema: { readonly type: "string"; }; export declare const ApiPushNotificationConfigListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPushNotificationConfigGetResponseDTO"; }; }; }; }; export declare const ApiPushNotificationConfigDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the Webhook was removed"; readonly example: false; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique Webhook Identifier"; readonly example: "bbf67496-1379-4b6d-a348-fd5fa229f1c"; readonly deprecated: false; }; }; }; export declare const ApiReceivableAnticipationConfigurationGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly creditCardAutomaticEnabled: { readonly type: "boolean"; readonly description: "Indicates whether automatic anticipation is enabled for credit card payments"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiReceivableAnticipationConfigurationUpdateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly creditCardAutomaticEnabled: { readonly type: "boolean"; readonly description: "Define whether automatic anticipation is enabled for credit card payments"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiReceivableAnticipationPathIdRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiReceivableAnticipationGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "receivableAnticipation"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique identifier of anticipation in Asaas"; readonly example: "9e7d8639-350f-45c0-8bc3-d4ddc5f4ebac"; readonly deprecated: false; }; readonly installment: { readonly type: "string"; readonly description: "Unique identifier of the installment to be anticipated"; readonly deprecated: false; readonly example: null; }; readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be anticipated."; readonly example: "pay_626366773834"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiReceivableAnticipationGetResponseReceivableAnticipationStatus"; }; readonly anticipationDate: { readonly type: "string"; readonly description: "Anticipation request date"; readonly format: "date"; readonly example: "2019-05-20"; readonly deprecated: false; }; readonly dueDate: { readonly type: "string"; readonly description: "Request due date"; readonly format: "date"; readonly example: "2019-05-26"; readonly deprecated: false; }; readonly requestDate: { readonly type: "string"; readonly description: "Anticipation request date"; readonly format: "date"; readonly example: "2019-05-14"; readonly deprecated: false; }; readonly fee: { readonly type: "number"; readonly description: "Anticipation fee"; readonly example: 2.33; readonly deprecated: false; }; readonly anticipationDays: { readonly type: "integer"; readonly description: "Number of days that were anticipated"; readonly format: "int32"; readonly example: 5; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net value discounted the anticipation fee"; readonly example: 73.68; readonly deprecated: false; }; readonly totalValue: { readonly type: "number"; readonly description: "Total amount of the payment to be anticipated"; readonly example: 80; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Anticipation value"; readonly example: 76.01; readonly deprecated: false; }; readonly denialObservation: { readonly type: "string"; readonly description: "Reason for rejecting the anticipation payment"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiReceivableAnticipationGetResponseReceivableAnticipationStatusSchema: { readonly type: "string"; readonly description: "Anticipation status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "DENIED", "CREDITED", "DEBITED", "CANCELLED", "OVERDUE", "SCHEDULED"]; }; export declare const ApiReceivableAnticipationSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly installment: { readonly type: "string"; readonly description: "ID of the installment to be anticipated"; readonly deprecated: false; readonly example: null; }; readonly payment: { readonly type: "string"; readonly description: "ID of the payment to be anticipated"; readonly example: "pay_626366773834"; readonly deprecated: false; }; readonly documents: { readonly $ref: "#/components/schemas/File"; }; }; }; export declare const ApiReceivableAnticipationListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiReceivableAnticipationGetResponseDTO"; }; }; }; }; export declare const ApiReceivableAnticipationListRequestReceivableAnticipationStatusSchema: { readonly type: "string"; readonly description: "Filter by status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "DENIED", "CREDITED", "DEBITED", "CANCELLED", "OVERDUE", "SCHEDULED"]; }; export declare const ApiReceivableAnticipationSimulateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly installment: { readonly type: "string"; readonly description: "ID of the installment to be anticipated"; readonly deprecated: false; readonly example: null; }; readonly payment: { readonly type: "string"; readonly description: "ID of the payment to be anticipated"; readonly example: "pay_626366773834"; readonly deprecated: false; }; }; }; export declare const ApiReceivableAnticipationSimulateResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly installment: { readonly type: "string"; readonly description: "Unique identifier of the installment to be anticipated"; readonly deprecated: false; readonly example: null; }; readonly payment: { readonly type: "string"; readonly description: "Unique identifier of the payment to be anticipated"; readonly example: "pay_626366773834"; readonly deprecated: false; }; readonly anticipationDate: { readonly type: "string"; readonly description: "Anticipation request date"; readonly format: "date"; readonly example: "2019-05-20"; readonly deprecated: false; }; readonly dueDate: { readonly type: "string"; readonly description: "Request due date"; readonly format: "date"; readonly example: "2019-05-26"; readonly deprecated: false; }; readonly fee: { readonly type: "number"; readonly description: "Anticipation fee"; readonly example: 2.33; readonly deprecated: false; }; readonly anticipationDays: { readonly type: "integer"; readonly description: "Number of days that were anticipated"; readonly format: "int32"; readonly example: 6; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net value discounted the anticipation fee"; readonly example: 73.68; readonly deprecated: false; }; readonly totalValue: { readonly type: "number"; readonly description: "Total amount of the payment to be anticipated"; readonly example: 80; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Anticipation value"; readonly example: 76.01; readonly deprecated: false; }; readonly isDocumentationRequired: { readonly type: "boolean"; readonly description: "Determines the obligation to send electronic invoices or service provision contracts when requesting anticipation payment"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiReceivableAnticipationLimitsResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly creditCard: { readonly $ref: "#/components/schemas/ApiReceivableAnticipationLimitsInfoResponseDTO"; }; readonly bankSlip: { readonly $ref: "#/components/schemas/ApiReceivableAnticipationLimitsInfoResponseDTO"; }; }; }; export declare const ApiReceivableAnticipationLimitsInfoResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly total: { readonly type: "number"; readonly description: "Anticipation limit released on the account"; readonly example: 50000; readonly deprecated: false; }; readonly available: { readonly type: "number"; readonly description: "Limit available to anticipate"; readonly example: 35360.7; readonly deprecated: false; }; }; readonly description: "Credit card anticipation limits"; readonly deprecated: false; }; export declare const ApiSubscriptionGetInvoicesRequestInvoiceStatusSchema: { readonly type: "string"; readonly description: "Filter by invoice status"; readonly example: "SCHEDULED"; readonly deprecated: false; readonly enum: readonly ["SCHEDULED", "WAITING_OVERDUE_PAYMENT", "PENDING", "SYNCHRONIZED", "AUTHORIZED", "PROCESSING_CANCELLATION", "CANCELLED", "CANCELLATION_DENIED", "ERROR", "NONE", "CANCELED"]; }; export declare const ApiSubscriptionInvoiceConfigUpdateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly deductions: { readonly type: "number"; readonly description: "Deductions. Deductions do not change the total value of the invoice, but they do change the ISS calculation basis."; readonly example: 55; readonly deprecated: false; }; readonly effectiveDatePeriod: { readonly type: "string"; readonly description: "When the invoice will be issued"; readonly example: "ON_PAYMENT_CONFIRMATION"; readonly deprecated: false; readonly enum: readonly ["ON_PAYMENT_CONFIRMATION", "ON_PAYMENT_DUE_DATE", "BEFORE_PAYMENT_DUE_DATE", "ON_DUE_DATE_MONTH", "ON_NEXT_MONTH"]; }; readonly receivedOnly: { readonly type: "boolean"; readonly description: "Issue only for paid charges"; readonly deprecated: false; readonly example: null; }; readonly daysBeforeDueDate: { readonly type: "integer"; readonly description: "Number of days before billing due date"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly observations: { readonly type: "string"; readonly description: "Additional notes on the invoice"; readonly example: "Regarding March work"; readonly deprecated: false; }; readonly taxes: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceTaxesDTO"; }; }; }; export declare const ApiSubscriptionInvoiceConfigGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly municipalServiceId: { readonly type: "string"; readonly description: "Unique municipal service identifier"; readonly deprecated: false; readonly example: null; }; readonly municipalServiceCode: { readonly type: "string"; readonly description: "Municipal Service Code"; readonly example: "1.01"; readonly deprecated: false; }; readonly municipalServiceName: { readonly type: "string"; readonly description: "Name of municipal service"; readonly deprecated: false; readonly example: null; }; readonly deductions: { readonly type: "number"; readonly description: "Deductions. Deductions do not change the total value of the invoice, but they do change the ISS calculation basis."; readonly example: 55; readonly deprecated: false; }; readonly invoiceCreationPeriod: { readonly type: "string"; readonly description: "When the invoice will be issued"; readonly example: "ON_PAYMENT_CONFIRMATION"; readonly deprecated: false; readonly enum: readonly ["ON_PAYMENT_CONFIRMATION", "ON_PAYMENT_DUE_DATE", "BEFORE_PAYMENT_DUE_DATE", "ON_DUE_DATE_MONTH", "ON_NEXT_MONTH"]; }; readonly daysBeforeDueDate: { readonly type: "integer"; readonly description: "Number of days before billing due date"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly receivedOnly: { readonly type: "boolean"; readonly description: "Issue only for paid charges"; readonly deprecated: false; readonly example: null; }; readonly observations: { readonly type: "string"; readonly description: "Additional notes on the invoice"; readonly example: "Regarding March work"; readonly deprecated: false; }; readonly taxes: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceTaxesDTO"; }; }; }; export declare const ApiSubscriptionDeleteInvoiceConfigResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Informs if configurations have been removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique subscription identifier in Asaas"; readonly example: "sub_VXJBYgP2u0eO"; readonly deprecated: false; }; }; }; export declare const ApiSubscriptionPaymentBookResponseDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiSubscriptionGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "subscription"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique subscription identifier in Asaas"; readonly example: "sub_VXJBYgP2u0eO"; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Subscription creation date"; readonly format: "date"; readonly example: "2017-03-17"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_0T1mdomVMi39"; readonly deprecated: false; }; readonly paymentLink: { readonly type: "string"; readonly description: "Unique identifier of the payments link to which the subscription belongs"; readonly deprecated: false; readonly example: null; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiSubscriptionGetResponseBillingType"; }; readonly cycle: { readonly $ref: "#/components/schemas/ApiSubscriptionGetResponseCycle"; }; readonly value: { readonly type: "number"; readonly description: "Subscription value"; readonly example: 19.9; readonly deprecated: false; }; readonly nextDueDate: { readonly type: "string"; readonly description: "Due date of the next payment to be generated"; readonly format: "date"; readonly example: "2017-06-15"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "Deadline for payments to be due"; readonly format: "date"; readonly example: "2018-06-15"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Subscription description"; readonly example: "Pro Plan Subscription"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiSubscriptionGetResponseSubscriptionStatus"; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineResponseDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestResponseDTO"; }; readonly deleted: { readonly type: "boolean"; readonly description: "Informs if the subscription has been removed"; readonly example: false; readonly deprecated: false; }; readonly maxPayments: { readonly type: "integer"; readonly description: "Maximum number of payments to be generated for this subscription"; readonly format: "int32"; readonly example: 12; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Subscription identifier on your system"; readonly deprecated: false; readonly example: null; }; readonly split: { readonly type: "array"; readonly description: "Split information"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly walletId: { readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly example: "7bafd95a-e783-4a62-9be1-23999af742c6"; readonly deprecated: false; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly example: 20.32; readonly deprecated: false; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; readonly status: { readonly $ref: "#/components/schemas/ApiSubscriptionSplitResponseSubscriptionSplitStatus"; }; readonly disabledReason: { readonly $ref: "#/components/schemas/ApiSubscriptionSplitResponseSubscriptionSplitDisabledReason"; }; }; }; }; }; }; export declare const ApiSubscriptionGetResponseBillingTypeSchema: { readonly type: "string"; readonly description: "Billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "TRANSFER", "DEPOSIT", "PIX"]; }; export declare const ApiSubscriptionGetResponseCycleSchema: { readonly type: "string"; readonly description: "Billing frequency"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiSubscriptionGetResponseSubscriptionStatusSchema: { readonly type: "string"; readonly description: "Subscription status"; readonly example: "ACTIVE"; readonly deprecated: false; readonly enum: readonly ["ACTIVE", "EXPIRED", "INACTIVE"]; }; export declare const ApiSubscriptionSplitResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly walletId: { readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly example: "7bafd95a-e783-4a62-9be1-23999af742c6"; readonly deprecated: false; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly example: 20.32; readonly deprecated: false; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; readonly status: { readonly $ref: "#/components/schemas/ApiSubscriptionSplitResponseSubscriptionSplitStatus"; }; readonly disabledReason: { readonly $ref: "#/components/schemas/ApiSubscriptionSplitResponseSubscriptionSplitDisabledReason"; }; }; }; export declare const ApiSubscriptionSplitResponseSubscriptionSplitStatusSchema: { readonly type: "string"; readonly description: "Subscription split status"; readonly example: "ACTIVE"; readonly deprecated: false; readonly enum: readonly ["ACTIVE", "DISABLED"]; }; export declare const ApiSubscriptionSplitResponseSubscriptionSplitDisabledReasonSchema: { readonly type: "string"; readonly description: "Reason why subscription split was disabled"; readonly example: "WALLET_UNABLE_TO_RECEIVE"; readonly deprecated: false; readonly enum: readonly ["WALLET_UNABLE_TO_RECEIVE", "VALUE_DIVERGENCE"]; }; export declare const ApiSubscriptionSaveRequestDTOSchema: { readonly required: readonly ["customer", "billingType", "value", "nextDueDate", "cycle"]; readonly type: "object"; readonly properties: { readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_0T1mdomVMi39"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiSubscriptionSaveRequestBillingType"; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Subscription value"; readonly example: 19.9; readonly deprecated: false; }; readonly nextDueDate: { readonly required: readonly ["nextDueDate"]; readonly type: "string"; readonly description: "First payment due"; readonly format: "date"; readonly example: "2017-05-15"; readonly deprecated: false; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly cycle: { readonly $ref: "#/components/schemas/ApiSubscriptionSaveRequestCycle"; }; readonly description: { readonly type: "string"; readonly description: "Subscription description (max. 500 characters)"; readonly example: "Pro Plan Subscription"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "Deadline for payments to be due"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly maxPayments: { readonly type: "integer"; readonly description: "Maximum number of payments to be generated for this subscription"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Subscription identifier on your system"; readonly deprecated: false; readonly example: null; }; readonly split: { readonly type: "array"; readonly description: "Split information"; readonly deprecated: false; readonly items: { readonly required: readonly ["walletId"]; readonly type: "object"; readonly properties: { readonly walletId: { readonly required: readonly ["walletId"]; readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly deprecated: false; readonly example: null; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly deprecated: false; readonly example: null; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; }; }; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; }; }; export declare const ApiSubscriptionSaveRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiSubscriptionSaveRequestCycleSchema: { readonly required: readonly ["cycle"]; readonly type: "string"; readonly description: "Billing frequency"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiSubscriptionSplitRequestDTOSchema: { readonly required: readonly ["walletId"]; readonly type: "object"; readonly properties: { readonly walletId: { readonly required: readonly ["walletId"]; readonly type: "string"; readonly description: "Asaas wallet identifier that will be transferred"; readonly deprecated: false; readonly example: null; }; readonly fixedValue: { readonly type: "number"; readonly description: "Fixed amount to be transferred to the account when the payment is received"; readonly deprecated: false; readonly example: null; }; readonly percentualValue: { readonly type: "number"; readonly description: "Percentage of the net value of the charge to be transferred when received"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Split identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Split description"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiSubscriptionUpdateRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly billingType: { readonly $ref: "#/components/schemas/ApiSubscriptionUpdateRequestBillingType"; }; readonly status: { readonly $ref: "#/components/schemas/ApiSubscriptionUpdateRequestSubscriptionStatus"; }; readonly nextDueDate: { readonly type: "string"; readonly description: "First payment due"; readonly format: "date"; readonly example: "2017-05-15"; readonly deprecated: false; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly cycle: { readonly $ref: "#/components/schemas/ApiSubscriptionUpdateRequestCycle"; }; readonly description: { readonly type: "string"; readonly description: "Subscription description (max. 500 characters)"; readonly example: "Pro Plan Subscription"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "Deadline for payments to be due"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly updatePendingPayments: { readonly type: "boolean"; readonly description: "true to update the possible properties of already existing pending payments"; readonly example: true; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Subscription identifier on your system"; readonly deprecated: false; readonly example: null; }; readonly split: { readonly type: "array"; readonly description: "Split information"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiSubscriptionSplitRequestDTO"; }; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; }; }; export declare const ApiSubscriptionUpdateRequestBillingTypeSchema: { readonly type: "string"; readonly description: "Billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiSubscriptionUpdateRequestSubscriptionStatusSchema: { readonly type: "string"; readonly description: "Subscription status"; readonly example: "ACTIVE"; readonly deprecated: false; readonly enum: readonly ["ACTIVE", "INACTIVE"]; }; export declare const ApiSubscriptionUpdateRequestCycleSchema: { readonly type: "string"; readonly description: "Billing frequency"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiSubscriptionConfigureInvoiceRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly municipalServiceId: { readonly type: "string"; readonly description: "Unique municipal service identifier"; readonly deprecated: false; readonly example: null; }; readonly municipalServiceCode: { readonly type: "string"; readonly description: "Municipal Service Code"; readonly example: "1.01"; readonly deprecated: false; }; readonly municipalServiceName: { readonly type: "string"; readonly description: "Name of municipal service"; readonly deprecated: false; readonly example: null; }; readonly updatePayment: { readonly type: "boolean"; readonly description: "Update the Payment amount with the invoice taxes already deducted."; readonly example: false; readonly deprecated: false; }; readonly deductions: { readonly type: "number"; readonly description: "Deductions. Deductions do not change the total value of the invoice, but they do change the ISS calculation basis."; readonly example: 55; readonly deprecated: false; }; readonly effectiveDatePeriod: { readonly type: "string"; readonly description: "When the invoice will be issued"; readonly example: "ON_PAYMENT_CONFIRMATION"; readonly deprecated: false; readonly enum: readonly ["ON_PAYMENT_CONFIRMATION", "ON_PAYMENT_DUE_DATE", "BEFORE_PAYMENT_DUE_DATE", "ON_DUE_DATE_MONTH", "ON_NEXT_MONTH"]; }; readonly receivedOnly: { readonly type: "boolean"; readonly description: "Issue only for paid charges"; readonly deprecated: false; readonly example: null; }; readonly daysBeforeDueDate: { readonly type: "integer"; readonly description: "Number of days before billing due date"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly observations: { readonly type: "string"; readonly description: "Additional notes on the invoice"; readonly example: "Regarding March work"; readonly deprecated: false; }; readonly taxes: { readonly $ref: "#/components/schemas/ApiCustomerInvoiceTaxesDTO"; }; }; }; export declare const ApiSubscriptionListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiSubscriptionGetResponseDTO"; }; }; }; }; export declare const ApiSubscriptionListRequestBillingTypeSchema: { readonly type: "string"; readonly description: "Filter by billing type"; readonly example: "UNDEFINED"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "TRANSFER", "DEPOSIT", "PIX"]; }; export declare const ApiSubscriptionListRequestSubscriptionStatusSchema: { readonly type: "string"; readonly description: "Filter by status"; readonly example: "ACTIVE"; readonly deprecated: false; readonly enum: readonly ["ACTIVE", "EXPIRED", "INACTIVE"]; }; export declare const ApiSubscriptionDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; readonly description: "Informs if the subscription has been removed"; readonly example: true; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique subscription identifier in Asaas"; readonly example: "sub_VXJBYgP2u0eO"; readonly deprecated: false; }; }; }; export declare const ApiTransferGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "transfer"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique transfer identifier in Asaas"; readonly example: "777eb7c8-b1a2-4356-8fd8-a1b0644b5282"; readonly deprecated: false; }; readonly type: { readonly type: "string"; readonly description: "Type of transfer"; readonly example: "BANK_ACCOUNT"; readonly deprecated: false; readonly enum: readonly ["PIX", "TED", "INTERNAL"]; }; readonly dateCreated: { readonly type: "string"; readonly description: "Transfer request date"; readonly format: "date"; readonly example: "2019-05-02"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Transfer amount"; readonly example: 1000; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net value minus transfer fee"; readonly example: 0; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiTransferGetResponseTransferStatus"; }; readonly transferFee: { readonly type: "number"; readonly description: "Transfer rate"; readonly example: 0; readonly deprecated: false; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Effective date"; readonly format: "date"; readonly example: "2019-05-02"; readonly deprecated: false; }; readonly scheduleDate: { readonly type: "string"; readonly description: "Schedule date"; readonly format: "date"; readonly example: "2019-05-02"; readonly deprecated: false; }; readonly endToEndIdentifier: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction at the Central Bank"; readonly deprecated: false; readonly example: null; }; readonly authorized: { readonly type: "boolean"; readonly description: "`false` when awaiting authorization via SMS Token"; readonly example: true; readonly deprecated: false; }; readonly failReason: { readonly type: "string"; readonly description: "Reason for transfer failure"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Transfer identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "Proof of transfer will be available after the transfer is confirmed"; readonly deprecated: false; readonly example: null; }; readonly operationType: { readonly $ref: "#/components/schemas/ApiTransferGetResponseTransferType"; }; readonly description: { readonly type: "string"; readonly description: "Transfer description"; readonly deprecated: false; readonly example: null; }; readonly recurring: { readonly type: "string"; readonly description: "Unique recurrence identifier in Asaas"; readonly deprecated: false; readonly example: null; }; readonly bankAccount: { readonly $ref: "#/components/schemas/ApiTransferBankAccountGetResponseDTO"; }; }; }; export declare const ApiTransferGetResponseTransferStatusSchema: { readonly type: "string"; readonly description: "Transfer status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "BANK_PROCESSING", "DONE", "CANCELLED", "FAILED"]; }; export declare const ApiTransferGetResponseTransferTypeSchema: { readonly type: "string"; readonly description: "Transfer method"; readonly example: "TED"; readonly deprecated: false; readonly enum: readonly ["PIX", "TED", "INTERNAL"]; }; export declare const ApiTransferBankAccountGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly bank: { readonly $ref: "#/components/schemas/ApiTransferBankGetResponseDTO"; }; readonly accountName: { readonly type: "string"; readonly description: "Name of bank account owner"; readonly example: "Banco do Brasil account"; readonly deprecated: false; }; readonly ownerName: { readonly type: "string"; readonly description: "Name of bank account owner"; readonly example: "John Doe"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the bank account owner"; readonly example: "***.143.689-**"; readonly deprecated: false; }; readonly agency: { readonly type: "string"; readonly description: "Non-digit agency number"; readonly example: "1263"; readonly deprecated: false; }; readonly agencyDigit: { readonly type: "string"; readonly description: "Agency digit"; readonly example: "3"; readonly deprecated: false; }; readonly account: { readonly type: "string"; readonly description: "Non-digit bank account number"; readonly example: "9999991"; readonly deprecated: false; }; readonly accountDigit: { readonly type: "string"; readonly description: "Bank account digit"; readonly example: "1"; readonly deprecated: false; }; readonly pixAddressKey: { readonly type: "string"; readonly description: "Pix key address"; readonly deprecated: false; readonly example: null; }; }; readonly description: "Bank account details"; readonly deprecated: false; }; export declare const ApiTransferBankGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly ispb: { readonly type: "string"; readonly description: "Identifier in the Brazilian Payment System"; readonly deprecated: false; readonly example: null; }; readonly code: { readonly type: "string"; readonly description: "Bank clearing code in the banking system"; readonly example: "001"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Bank name"; readonly example: "Banco do Brasil"; readonly deprecated: false; }; }; readonly description: "Bank account name"; readonly deprecated: false; }; export declare const ApiTransferSaveRequestDTOSchema: { readonly required: readonly ["value"]; readonly type: "object"; readonly properties: { readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Amount to be transferred"; readonly example: 1000; readonly deprecated: false; }; readonly bankAccount: { readonly $ref: "#/components/schemas/ApiTransferBankAccountSaveRequestDTO"; }; readonly operationType: { readonly $ref: "#/components/schemas/ApiTransferSaveRequestTransferType"; }; readonly pixAddressKey: { readonly type: "string"; readonly description: "Enter the Pix key if it is a transfer to a Pix key"; readonly deprecated: false; readonly example: null; }; readonly pixAddressKeyType: { readonly $ref: "#/components/schemas/ApiTransferSaveRequestPixAddressKeyType"; }; readonly description: { readonly type: "string"; readonly description: "Transfers via Pix allow description"; readonly example: "Barbecue paid via Pix scheduled"; readonly deprecated: false; }; readonly scheduleDate: { readonly type: "string"; readonly description: "For scheduled transfers, if not informed, payment is instantaneous"; readonly format: "date"; readonly example: "2018-01-26"; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Transfer identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly recurring: { readonly $ref: "#/components/schemas/ApiTransferRecurringSaveRequestDTO"; }; }; }; export declare const ApiTransferBankAccountSaveRequestDTOSchema: { readonly required: readonly ["ownerName", "cpfCnpj", "agency", "account", "accountDigit"]; readonly type: "object"; readonly properties: { readonly bank: { readonly $ref: "#/components/schemas/ApiTransferBankSaveRequestDTO"; }; readonly accountName: { readonly type: "string"; readonly description: "Bank account name"; readonly example: "Bradesco account"; readonly deprecated: false; }; readonly ownerName: { readonly required: readonly ["ownerName"]; readonly type: "string"; readonly description: "Name of bank account owner"; readonly example: "John Doe"; readonly deprecated: false; }; readonly ownerBirthDate: { readonly type: "string"; readonly description: "Account owner's date of birth. Only when the bank account does not belong to the same CPF or CNPJ as the Asaas account."; readonly format: "date"; readonly example: "1995-04-12"; readonly deprecated: false; }; readonly cpfCnpj: { readonly required: readonly ["cpfCnpj"]; readonly type: "string"; readonly description: "CPF or CNPJ of the bank account owner"; readonly example: "52233424611"; readonly deprecated: false; }; readonly agency: { readonly required: readonly ["agency"]; readonly type: "string"; readonly description: "Non-digit agency number"; readonly example: "1263"; readonly deprecated: false; }; readonly account: { readonly required: readonly ["account"]; readonly type: "string"; readonly description: "Non-digit bank account number"; readonly example: "9999991"; readonly deprecated: false; }; readonly accountDigit: { readonly required: readonly ["accountDigit"]; readonly type: "string"; readonly description: "Bank account digit"; readonly example: "1"; readonly deprecated: false; }; readonly bankAccountType: { readonly $ref: "#/components/schemas/ApiTransferBankAccountSaveRequestBankAccountType"; }; readonly ispb: { readonly type: "string"; readonly description: "Identifier in the Brazilian Payment System"; readonly example: "60746948"; readonly deprecated: false; }; }; readonly description: "Enter your account details if it is a transfer to a bank account"; readonly deprecated: false; }; export declare const ApiTransferBankSaveRequestDTOSchema: { readonly required: readonly ["code"]; readonly type: "object"; readonly properties: { readonly code: { readonly required: readonly ["code"]; readonly type: "string"; readonly description: "Bank clearing code in the banking system"; readonly example: "237"; readonly deprecated: false; }; }; readonly description: "Details of the bank account to which the transfer will be made"; readonly deprecated: false; }; export declare const ApiTransferBankAccountSaveRequestBankAccountTypeSchema: { readonly type: "string"; readonly description: "Account type"; readonly example: "CONTA_CORRENTE"; readonly deprecated: false; readonly enum: readonly ["CONTA_CORRENTE", "CONTA_POUPANCA"]; }; export declare const ApiTransferSaveRequestTransferTypeSchema: { readonly type: "string"; readonly description: "Transfer modality. If not informed and the receiving institution is a Pix participant, the transfer is via Pix. Otherwise via TED."; readonly example: "PIX"; readonly deprecated: false; readonly enum: readonly ["PIX", "TED"]; }; export declare const ApiTransferSaveRequestPixAddressKeyTypeSchema: { readonly type: "string"; readonly description: "Enter the type of key if it is a transfer to a Pix key"; readonly example: "EVP"; readonly deprecated: false; readonly enum: readonly ["CPF", "CNPJ", "EMAIL", "PHONE", "EVP"]; }; export declare const ApiTransferRecurringSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly frequency: { readonly $ref: "#/components/schemas/ApiTransferRecurringSaveRequestRecurringCheckoutScheduleFrequency"; }; readonly quantity: { readonly maximum: 52; readonly minimum: 1; readonly type: "integer"; readonly description: "Number of repetitions. This transfer will be included as the first transaction of the recurrence.\n For the `WEEKLY` frequency, the maximum accepted is: `52`\n For the `MONTHLY` frequency, the maximum accepted is: `12`"; readonly format: "int32"; readonly example: 3; readonly deprecated: false; }; }; readonly description: "Recurrence information. Only for Pix transfers"; readonly deprecated: false; }; export declare const ApiTransferRecurringSaveRequestRecurringCheckoutScheduleFrequencySchema: { readonly type: "string"; readonly description: "Frequency"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "MONTHLY"]; }; export declare const ApiTransferListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiTransferGetResponseDTO"; }; }; }; }; export declare const ApiWalletShowResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "wallet"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique wallet identifier in Asaas"; readonly example: "0000c712-0a0b-a0b0-0000-031e7ac51a2"; readonly deprecated: false; }; }; }; }; }; }; export declare const ApiWalletGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "wallet"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique wallet identifier in Asaas"; readonly example: "0000c712-0a0b-a0b0-0000-031e7ac51a2"; readonly deprecated: false; }; }; }; export declare const ApiPaymentLeanGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "payment"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique payment identifier in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Payment creation date"; readonly format: "date"; readonly example: "2017-03-10"; readonly deprecated: false; }; readonly customerId: { readonly type: "string"; readonly description: "Unique identifier of the customer to whom the payment belongs"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly subscriptionId: { readonly type: "string"; readonly description: "Unique subscription identifier (when recurring billing)"; readonly deprecated: false; readonly example: null; }; readonly installmentId: { readonly type: "string"; readonly description: "Unique installment identifier (when billing in installments)"; readonly deprecated: false; readonly example: null; }; readonly paymentLinkId: { readonly type: "string"; readonly description: "Unique identifier of the payments link to which the payment belongs"; readonly deprecated: false; readonly example: null; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 129.9; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net value of the charge after discounting the Asaas fee"; readonly example: 124.9; readonly deprecated: false; }; readonly originalValue: { readonly type: "number"; readonly description: "Original amount of charge (filled when paid with interest and fine)"; readonly deprecated: false; readonly example: null; }; readonly interestValue: { readonly type: "number"; readonly description: "Calculated amount of interest and fine that must be paid after the charge is due"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Description of the payment"; readonly example: "Pedido 056984"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentLeanGetResponseBillingType"; }; readonly canBePaidAfterDueDate: { readonly type: "boolean"; readonly description: "Informs whether the charge can be paid after the due date (Only for bank slip)"; readonly example: true; readonly deprecated: false; }; readonly confirmedDate: { readonly type: "string"; readonly description: "Billing confirmation date"; readonly format: "date"; readonly example: "2017-03-10"; readonly deprecated: false; }; readonly pixTransactionId: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction to which the payment belongs"; readonly deprecated: false; readonly example: null; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentLeanGetResponsePaymentStatus"; }; readonly dueDate: { readonly type: "string"; readonly description: "Payment due date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly originalDueDate: { readonly type: "string"; readonly description: "Original due date upon creation of the payment"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly paymentDate: { readonly type: "string"; readonly description: "Payment date on Asaas"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly customerPaymentDate: { readonly type: "string"; readonly description: "Date on which the customer paid the bank slip"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly installmentNumber: { readonly type: "integer"; readonly description: "Parcel number"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly deleted: { readonly type: "boolean"; readonly description: "Determines if the payment has been removed"; readonly example: false; readonly deprecated: false; }; readonly anticipated: { readonly type: "boolean"; readonly description: "Defines whether the charge was anticipated or is in the process of being anticipated"; readonly example: false; readonly deprecated: false; }; readonly anticipable: { readonly type: "boolean"; readonly description: "Determines whether the charge is anticipated"; readonly example: false; readonly deprecated: false; }; readonly creditDate: { readonly type: "string"; readonly description: "Billing Credit date"; readonly example: "2017-03-10"; readonly deprecated: false; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "URL of proof of confirmation, receipt, reversal or removal"; readonly deprecated: false; readonly example: null; }; readonly duplicatedPaymentId: { readonly type: "string"; readonly description: "Duplicate billing identifier (if true)"; readonly deprecated: false; readonly example: null; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineResponseDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestResponseDTO"; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; }; }; export declare const ApiPaymentLeanGetResponseBillingTypeSchema: { readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "TRANSFER", "DEPOSIT", "PIX"]; }; export declare const ApiPaymentLeanGetResponsePaymentStatusSchema: { readonly type: "string"; readonly description: "Payment status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE", "REFUNDED", "RECEIVED_IN_CASH", "REFUND_REQUESTED", "REFUND_IN_PROGRESS", "CHARGEBACK_REQUESTED", "CHARGEBACK_DISPUTE", "AWAITING_CHARGEBACK_REVERSAL", "DUNNING_REQUESTED", "DUNNING_RECEIVED", "AWAITING_RISK_ANALYSIS"]; }; export declare const ApiPaymentLeanListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentLeanGetResponseDTO"; }; }; }; }; export declare const ApiPixAddressKeyGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique Pix key identifier in Asaas"; readonly example: "a33047b1-fb19-4b68-9373-a7ba8a8162aa"; readonly deprecated: false; }; readonly key: { readonly type: "string"; readonly description: "Key value"; readonly example: "b6295ee1-f054-47d1-9e90-ee57b74f60d9"; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiPixAddressKeyGetResponsePixAddressKeyType"; }; readonly status: { readonly $ref: "#/components/schemas/ApiPixAddressKeyGetResponsePixAddressKeyStatus"; }; readonly dateCreated: { readonly type: "string"; readonly description: "Key creation date"; readonly format: "date-time"; readonly example: "2022-02-07 17:17:48"; readonly deprecated: false; }; readonly canBeDeleted: { readonly type: "boolean"; readonly description: "Determines whether the key can be deleted"; readonly example: true; readonly deprecated: false; }; readonly cannotBeDeletedReason: { readonly type: "string"; readonly description: "Reason it cannot be removed"; readonly deprecated: false; readonly example: null; }; readonly qrCode: { readonly $ref: "#/components/schemas/ApiPixAddressKeyQrCodeGetResponseDTO"; }; }; }; export declare const ApiPixAddressKeyGetResponsePixAddressKeyTypeSchema: { readonly type: "string"; readonly description: "Pix key type"; readonly example: "EVP"; readonly deprecated: false; readonly enum: readonly ["EVP"]; }; export declare const ApiPixAddressKeyGetResponsePixAddressKeyStatusSchema: { readonly type: "string"; readonly description: "Key status"; readonly example: "ACTIVE"; readonly deprecated: false; readonly enum: readonly ["AWAITING_ACTIVATION", "ACTIVE", "AWAITING_DELETION", "AWAITING_ACCOUNT_DELETION", "DELETED", "ERROR"]; }; export declare const ApiPixAddressKeyQrCodeGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly encodedImage: { readonly type: "string"; readonly description: "QrCode image in base64"; readonly example: "QRCODE IMAGE IN BASE64"; readonly deprecated: false; }; readonly payload: { readonly type: "string"; readonly description: "Copy and Paste the QrCode"; readonly example: "00020126580014br.gov.bcb.pix0136a9fe43bc-164d-44d1-91c2-2f9b4d6956e95204000053039865802BR5925Joao da Silva6009Joinville62290525JOAOSILVA00000055ASA6304E62B"; readonly deprecated: false; }; }; readonly description: "Pix key QRCode"; readonly deprecated: false; }; export declare const ApiPixAddressKeySaveRequestDTOSchema: { readonly required: readonly ["type"]; readonly type: "object"; readonly properties: { readonly type: { readonly $ref: "#/components/schemas/ApiPixAddressKeySaveRequestPixAddressKeyType"; }; }; }; export declare const ApiPixAddressKeySaveRequestPixAddressKeyTypeSchema: { readonly required: readonly ["type"]; readonly type: "string"; readonly description: "Pix key type"; readonly example: "EVP"; readonly deprecated: false; readonly enum: readonly ["EVP"]; }; export declare const ApiPixAddressKeyListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPixAddressKeyGetResponseDTO"; }; }; }; }; export declare const ApiPixAddressKeyListRequestPixAddressKeyStatusSchema: { readonly type: "string"; readonly description: "Filter by current key status"; readonly example: "AWAITING_ACTIVATION"; readonly deprecated: false; readonly enum: readonly ["AWAITING_ACTIVATION", "ACTIVE", "AWAITING_DELETION", "AWAITING_ACCOUNT_DELETION", "DELETED", "ERROR"]; }; export declare const ApiPixQrCodeSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly addressKey: { readonly type: "string"; readonly description: "Key that will receive QrCode payments"; readonly example: "b6295ee1-f054-47d1-9e90-ee57b74f60d9"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "QrCode Description"; readonly example: "Barbecue"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Value of the QrCode, if not informed, the payer can choose the value"; readonly example: 50; readonly deprecated: false; }; readonly format: { readonly type: "string"; readonly description: "QrCode Format"; readonly example: "ALL"; readonly deprecated: false; readonly enum: readonly ["ALL", "IMAGE", "PAYLOAD"]; }; readonly expirationDate: { readonly type: "string"; readonly description: "QrCode expiration date/time, after this date all payments will be refused."; readonly format: "date-time"; readonly example: "2023-05-05 14:20:50"; readonly deprecated: false; }; readonly expirationSeconds: { readonly type: "integer"; readonly description: "Determines the expiration date in seconds."; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly allowsMultiplePayments: { readonly type: "boolean"; readonly description: "Defines whether the QrCode can be paid multiple times, if not entered the default value is true."; readonly example: true; readonly deprecated: false; }; readonly externalReference: { readonly maxLength: 100; readonly type: "string"; readonly description: "Free search field"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPixQrCodeSaveResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "qrCode image in base64"; readonly example: "9bea9bcd126b45c7939960f577be84d6"; readonly deprecated: false; }; readonly encodedImage: { readonly type: "string"; readonly description: "QrCode identifier"; readonly example: "QRCODE IMAGE IN BASE64"; readonly deprecated: false; }; readonly payload: { readonly type: "string"; readonly description: "Copy and Paste the QrCode"; readonly example: "00020126580014br.gov.bcb.pix0136a9fe43bc-164d-44d1-91c2-2f9b4d6956e95204000053039865802BR5925Churrasco6009Joinville62290525JOAOSILVA00000055ASA6304E62B"; readonly deprecated: false; }; readonly allowsMultiplePayments: { readonly type: "boolean"; readonly description: "Indicates whether multiple payments are allowed"; readonly example: true; readonly deprecated: false; }; readonly expirationDate: { readonly type: "string"; readonly description: "QrCode expiration date/time, after this date all payments will be refused"; readonly format: "date-time"; readonly example: "2023-05-05 14:20:5"; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPixQrCodeDecodeRequestDTOSchema: { readonly required: readonly ["payload"]; readonly type: "object"; readonly properties: { readonly payload: { readonly required: readonly ["payload"]; readonly type: "string"; readonly description: "QRCode payload"; readonly example: "00020101021226730014br.gov.bcb.pix2551pix-h.asaas.com/pixqrcode/cobv/pay_76575613967995145204000053039865802BR5905ASAAS6009Joinville61088922827162070503***63045E7A"; readonly deprecated: false; }; readonly changeValue: { readonly type: "number"; readonly description: "Change amount (for QRCode Change)"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPixQrCodeDecodeResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly payload: { readonly type: "string"; readonly description: "Copy and Paste of the QRCode"; readonly example: "00020101021226730014br.gov.bcb.pix2551pix-h.asaas.com/pixqrcode/cobv/pay_76575613967995145204000053039865802BR5905ASAAS6009Joinville61088922827162070503***63045E7A"; readonly deprecated: false; }; readonly type: { readonly $ref: "#/components/schemas/ApiPixQrCodeDecodeResponsePixQrCodeType"; }; readonly transactionOriginType: { readonly $ref: "#/components/schemas/ApiPixQrCodeDecodeResponsePixTransactionOriginType"; }; readonly pixKey: { readonly type: "string"; readonly description: "Pix key used"; readonly example: "f9560206-807f-4273-ad72-d9ba9ddd867b"; readonly deprecated: false; }; readonly conciliationIdentifier: { readonly type: "string"; readonly description: "Unique Pix reconciliation identifier with Asaas"; readonly example: "dcabae5bbfb6nffbb87c69388365648"; readonly deprecated: false; }; readonly endToEndIdentifier: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction at the Banco Central"; readonly example: "E238472938479238461974982374923"; readonly deprecated: false; }; readonly dueDate: { readonly type: "string"; readonly description: "Due date"; readonly format: "date"; readonly example: "2030-02-05"; readonly deprecated: false; }; readonly expirationDate: { readonly type: "string"; readonly description: "Expiration date"; readonly format: "date-time"; readonly example: "030-02-10 11:00:00"; readonly deprecated: false; }; readonly finality: { readonly $ref: "#/components/schemas/ApiPixQrCodeDecodeResponsePixTransactionCashValueFinality"; }; readonly value: { readonly type: "number"; readonly description: "QRCode Value"; readonly example: 100; readonly deprecated: false; }; readonly changeValue: { readonly type: "number"; readonly description: "Change value"; readonly example: 2; readonly deprecated: false; }; readonly interest: { readonly type: "number"; readonly description: "Interest value"; readonly example: 1; readonly deprecated: false; }; readonly fine: { readonly type: "number"; readonly description: "Fine value"; readonly example: 3; readonly deprecated: false; }; readonly discount: { readonly type: "number"; readonly description: "Discount value"; readonly example: 5; readonly deprecated: false; }; readonly totalValue: { readonly type: "number"; readonly description: "Total amount with fine, interest and discount applied"; readonly example: 99; readonly deprecated: false; }; readonly canBePaidWithDifferentValue: { readonly type: "boolean"; readonly description: "Informs if the QRCode can be paid with another amount"; readonly example: true; readonly deprecated: false; }; readonly canBeModifyChangeValue: { readonly type: "boolean"; readonly description: "Informs whether the change can be paid with another amount"; readonly example: false; readonly deprecated: false; }; readonly receiver: { readonly $ref: "#/components/schemas/ApiPixQrCodeDecodeReceiverDTO"; }; readonly payer: { readonly $ref: "#/components/schemas/ApiPixTransactionQrCodePayerResponseDTO"; }; readonly description: { readonly type: "string"; readonly description: "Description provided during the creation of the QRCode"; readonly deprecated: false; readonly example: null; }; readonly canBePaid: { readonly type: "boolean"; readonly description: "Informs if the QRCode can be paid"; readonly example: true; readonly deprecated: false; }; readonly cannotBePaidReason: { readonly type: "string"; readonly description: "Informs why QRCode cannot be paid"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPixQrCodeDecodeResponsePixQrCodeTypeSchema: { readonly type: "string"; readonly description: "QRCode Type"; readonly example: "DYNAMIC"; readonly deprecated: false; readonly enum: readonly ["STATIC", "DYNAMIC", "DYNAMIC_WITH_ASAAS_ADDRESS_KEY"]; }; export declare const ApiPixQrCodeDecodeResponsePixTransactionOriginTypeSchema: { readonly type: "string"; readonly description: "Transaction origin"; readonly example: "DYNAMIC_QRCODE"; readonly deprecated: false; readonly enum: readonly ["MANUAL", "ADDRESS_KEY", "STATIC_QRCODE", "DYNAMIC_QRCODE", "PAYMENT_INITIATION_SERVICE"]; }; export declare const ApiPixQrCodeDecodeResponsePixTransactionCashValueFinalitySchema: { readonly type: "string"; readonly description: "Used to indicate whether it is a Withdrawal or Change"; readonly example: "CHANGE"; readonly deprecated: false; readonly enum: readonly ["WITHDRAWAL", "CHANGE"]; }; export declare const ApiPixQrCodeDecodeReceiverDTOSchema: { readonly type: "object"; readonly properties: { readonly ispb: { readonly type: "string"; readonly description: "Financial institution code"; readonly deprecated: false; readonly example: null; }; readonly ispbName: { readonly type: "string"; readonly description: "Name of the financial institution"; readonly deprecated: false; readonly example: null; }; readonly name: { readonly type: "string"; readonly description: "Receiver name"; readonly deprecated: false; readonly example: null; }; readonly tradingName: { readonly type: "string"; readonly description: "Receiver's trade name"; readonly deprecated: false; readonly example: null; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the receiver"; readonly deprecated: false; readonly example: null; }; readonly personType: { readonly $ref: "#/components/schemas/ApiPixQrCodeDecodeReceiverPersonType"; }; readonly accountType: { readonly $ref: "#/components/schemas/ApiPixQrCodeDecodeReceiverPixAccountType"; }; }; readonly description: "Information about the receiver"; readonly deprecated: false; }; export declare const ApiPixQrCodeDecodeReceiverPersonTypeSchema: { readonly type: "string"; readonly description: "Person type"; readonly example: "JURIDICA"; readonly deprecated: false; readonly enum: readonly ["JURIDICA", "FISICA"]; }; export declare const ApiPixQrCodeDecodeReceiverPixAccountTypeSchema: { readonly type: "string"; readonly description: "Receiver account type"; readonly example: "CHECKING_ACCOUNT"; readonly deprecated: false; readonly enum: readonly ["CHECKING_ACCOUNT", "SALARY_ACCOUNT", "INVESTIMENT_ACCOUNT", "PAYMENT_ACCOUNT"]; }; export declare const ApiPixTransactionQrCodePayerResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Payer's name"; readonly example: "Elon Musk"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the payer"; readonly example: "***.456.789-**"; readonly deprecated: false; }; }; readonly description: "Information about the payer"; readonly deprecated: false; }; export declare const ApiPixQrCodeDeleteResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "QR Code identifier"; readonly example: "ASAAS00000000000000383ASA"; readonly deprecated: false; }; readonly deleted: { readonly type: "boolean"; readonly description: "Indicates whether the QR Code has been removed"; readonly example: true; readonly deprecated: false; }; }; }; export declare const ApiPixTransactionCancelRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiPixTransactionGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction in Asaas"; readonly example: "35363f6e-93e2-11ec-b9d9-96f4053b1bd4"; readonly deprecated: false; }; readonly endToEndIdentifier: { readonly type: "string"; readonly description: "Pix transaction identifier at the Central Bank"; readonly example: "E00416968202111161635q5bk0brYk2C"; readonly deprecated: false; }; readonly finality: { readonly $ref: "#/components/schemas/ApiPixTransactionGetResponsePixTransactionCashValueFinality"; }; readonly value: { readonly type: "number"; readonly description: "Transaction or Withdrawal Value"; readonly example: 10; readonly deprecated: false; }; readonly changeValue: { readonly type: "number"; readonly description: "Change value"; readonly deprecated: false; readonly example: null; }; readonly refundedValue: { readonly type: "number"; readonly description: "Value reversed"; readonly example: 0; readonly deprecated: false; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Transaction date"; readonly format: "date-time"; readonly example: "2022-01-13 10:49:59"; readonly deprecated: false; }; readonly scheduledDate: { readonly type: "string"; readonly description: "Schedule date"; readonly format: "date"; readonly example: "2022-10-18"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPixTransactionGetResponsePixTransactionStatus"; }; readonly type: { readonly $ref: "#/components/schemas/ApiPixTransactionGetResponsePixTransactionType"; }; readonly originType: { readonly $ref: "#/components/schemas/ApiPixTransactionGetResponsePixTransactionOriginType"; }; readonly conciliationIdentifier: { readonly type: "string"; readonly description: "QrCode identifier linked to the transaction"; readonly example: "dcabae5bbfb6nffbb87c693883656483"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Description about the transaction"; readonly deprecated: false; readonly example: null; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "Proof of transaction will be available after the transaction is confirmed."; readonly deprecated: false; readonly example: null; }; readonly refusalReason: { readonly type: "string"; readonly description: "Reason why the transaction was declined"; readonly deprecated: false; readonly example: null; }; readonly canBeCanceled: { readonly type: "boolean"; readonly description: "Indicates whether the transaction can be canceled"; readonly example: true; readonly deprecated: false; }; readonly originalTransaction: { readonly $ref: "#/components/schemas/ApiPixOriginalTransactionResponseDTO"; }; readonly externalAccount: { readonly $ref: "#/components/schemas/ApiPixTransactionExternalAccountResponseDTO"; }; readonly qrCode: { readonly $ref: "#/components/schemas/ApiPixTransactionQrCodeResponseDTO"; }; readonly payment: { readonly type: "string"; readonly description: "Unique billing identifier"; readonly example: "pay_0491859546906926"; readonly deprecated: false; }; readonly canBeRefunded: { readonly type: "boolean"; readonly description: "Indicates whether the transaction can be refunded"; readonly example: true; readonly deprecated: false; }; readonly refundDisabledReason: { readonly type: "string"; readonly description: "Reason why the chargeback was disabled"; readonly deprecated: false; readonly example: null; }; readonly chargedFeeValue: { readonly type: "number"; readonly description: "Debit or credit fee for the transaction"; readonly example: 0.99; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Transaction creation date"; readonly format: "date-time"; readonly example: "023-02-14 10:42:55"; readonly deprecated: false; }; readonly addressKey: { readonly type: "string"; readonly description: "Pix key when the transaction is a credit"; readonly deprecated: false; readonly example: null; }; readonly addressKeyType: { readonly $ref: "#/components/schemas/ApiPixTransactionGetResponsePixAddressKeyType"; }; readonly transferId: { readonly type: "string"; readonly description: "Transfer identifier"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPixTransactionGetResponsePixTransactionCashValueFinalitySchema: { readonly type: "string"; readonly description: "Used to indicate whether it is a Withdrawal or Change"; readonly example: "WITHDRAWAL"; readonly deprecated: false; readonly enum: readonly ["WITHDRAWAL", "CHANGE"]; }; export declare const ApiPixTransactionGetResponsePixTransactionStatusSchema: { readonly type: "string"; readonly description: "Transaction status"; readonly example: "SCHEDULED"; readonly deprecated: false; readonly enum: readonly ["AWAITING_BALANCE_VALIDATION", "AWAITING_INSTANT_PAYMENT_ACCOUNT_BALANCE", "AWAITING_CRITICAL_ACTION_AUTHORIZATION", "AWAITING_CHECKOUT_RISK_ANALYSIS_REQUEST", "AWAITING_CASH_IN_RISK_ANALYSIS_REQUEST", "SCHEDULED", "AWAITING_REQUEST", "REQUESTED", "DONE", "REFUSED", "CANCELLED"]; }; export declare const ApiPixTransactionGetResponsePixTransactionTypeSchema: { readonly type: "string"; readonly description: "Transaction type"; readonly example: "DEBIT"; readonly deprecated: false; readonly enum: readonly ["DEBIT", "CREDIT", "CREDIT_REFUND", "DEBIT_REFUND", "DEBIT_REFUND_CANCELLATION"]; }; export declare const ApiPixTransactionGetResponsePixTransactionOriginTypeSchema: { readonly type: "string"; readonly description: "Indicates the origin of the transaction"; readonly example: "DYNAMIC_QRCODE"; readonly deprecated: false; readonly enum: readonly ["MANUAL", "ADDRESS_KEY", "STATIC_QRCODE", "DYNAMIC_QRCODE", "PAYMENT_INITIATION_SERVICE"]; }; export declare const ApiPixOriginalTransactionResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique transaction identifier"; readonly deprecated: false; readonly example: null; }; readonly endToEndIdentifier: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction at the Central Bank"; readonly deprecated: false; readonly example: null; }; readonly value: { readonly type: "number"; readonly description: "Original transaction value"; readonly deprecated: false; readonly example: null; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Transaction date"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; }; readonly description: "Original transaction information if a chargeback has occurred"; readonly deprecated: false; }; export declare const ApiPixTransactionExternalAccountResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly ispb: { readonly type: "string"; readonly description: "Payment Institution Identifier"; readonly example: "416968"; readonly deprecated: false; }; readonly ispbName: { readonly type: "string"; readonly description: "Name of Payment Institution"; readonly example: "Example Bank S.A"; readonly deprecated: false; }; readonly name: { readonly type: "string"; readonly description: "Receiver name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the recipient"; readonly example: "***.456.789-**"; readonly deprecated: false; }; readonly addressKey: { readonly type: "string"; readonly description: "Pix Key"; readonly example: "12345678910"; readonly deprecated: false; }; readonly addressKeyType: { readonly $ref: "#/components/schemas/ApiPixTransactionExternalAccountResponsePixAddressKeyType"; }; }; readonly description: "Information about the recipient"; readonly deprecated: false; }; export declare const ApiPixTransactionExternalAccountResponsePixAddressKeyTypeSchema: { readonly type: "string"; readonly description: "Pix key type"; readonly example: "CPF"; readonly deprecated: false; readonly enum: readonly ["CPF", "CNPJ", "EMAIL", "PHONE", "EVP"]; }; export declare const ApiPixTransactionQrCodeResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly payer: { readonly $ref: "#/components/schemas/ApiPixTransactionQrCodePayerResponseDTO"; }; readonly conciliationIdentifier: { readonly type: "string"; readonly description: "Unique Pix reconciliation identifier with Asaas"; readonly example: "dcabae5bbfb6nffbb87c693883656483"; readonly deprecated: false; }; readonly originalValue: { readonly type: "number"; readonly description: "Original transaction value"; readonly example: 99; readonly deprecated: false; }; readonly dueDate: { readonly type: "string"; readonly description: "Due date"; readonly format: "date"; readonly example: "2030-02-05"; readonly deprecated: false; }; readonly interest: { readonly type: "number"; readonly description: "Interest value"; readonly example: 1; readonly deprecated: false; }; readonly fine: { readonly type: "number"; readonly description: "Fine value"; readonly example: 3; readonly deprecated: false; }; readonly discount: { readonly type: "number"; readonly description: "Discount amount"; readonly example: 5; readonly deprecated: false; }; readonly expirationDate: { readonly type: "string"; readonly description: "Expiration date"; readonly format: "date-time"; readonly example: "2030-02-10 11:00:00"; readonly deprecated: false; }; }; readonly description: "Information about QrCode"; readonly deprecated: false; }; export declare const ApiPixTransactionGetResponsePixAddressKeyTypeSchema: { readonly type: "string"; readonly description: "Pix key type"; readonly example: "CPF"; readonly deprecated: false; readonly enum: readonly ["CPF", "CNPJ", "EMAIL", "PHONE", "EVP"]; }; export declare const ApiPixTransactionSaveRequestDTOSchema: { readonly required: readonly ["qrCode", "value"]; readonly type: "object"; readonly properties: { readonly qrCode: { readonly $ref: "#/components/schemas/ApiPixTransactionQrCodeSaveRequestDTO"; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Value to be paid"; readonly example: 100; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payment Description"; readonly example: "Barbecue"; readonly deprecated: false; }; readonly scheduleDate: { readonly type: "string"; readonly description: "Used to schedule payment"; readonly format: "date"; readonly example: "2022-03-15"; readonly deprecated: false; }; }; }; export declare const ApiPixTransactionQrCodeSaveRequestDTOSchema: { readonly type: "object"; readonly properties: { readonly payload: { readonly required: readonly ["payload"]; readonly type: "string"; readonly description: "QRCode payload"; readonly deprecated: false; readonly example: null; }; readonly changeValue: { readonly type: "number"; readonly description: "Change amount (for QRCode Change)"; readonly deprecated: false; readonly example: null; }; }; readonly description: "QRCode payload for payment"; readonly deprecated: false; }; export declare const ApiPixTransactionListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPixTransactionGetResponseDTO"; }; }; }; }; export declare const ApiPixTransactionListRequestPixTransactionStatusSchema: { readonly type: "string"; readonly description: "Filter by transaction status"; readonly example: "AWAITING_BALANCE_VALIDATION"; readonly deprecated: false; readonly enum: readonly ["AWAITING_BALANCE_VALIDATION", "AWAITING_INSTANT_PAYMENT_ACCOUNT_BALANCE", "AWAITING_CRITICAL_ACTION_AUTHORIZATION", "AWAITING_CHECKOUT_RISK_ANALYSIS_REQUEST", "AWAITING_CASH_IN_RISK_ANALYSIS_REQUEST", "SCHEDULED", "AWAITING_REQUEST", "REQUESTED", "DONE", "REFUSED", "CANCELLED"]; }; export declare const ApiPixTransactionListRequestPixTransactionTypeSchema: { readonly type: "string"; readonly description: "Filter by transaction type"; readonly example: "DEBIT"; readonly deprecated: false; readonly enum: readonly ["DEBIT", "CREDIT", "CREDIT_REFUND", "DEBIT_REFUND", "DEBIT_REFUND_CANCELLATION"]; }; export declare const ApiPixTransactionRecurringCheckoutScheduleCancelItemRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiPixTransactionRecurringCheckoutScheduleGetItemResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique recurrence item identifier in Asaas"; readonly example: "71ae9d73-468f-4d04-8b87-a541128f9c46"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleGetItemResponseRecurringCheckoutSchedulePixItemStatus"; }; readonly scheduledDate: { readonly type: "string"; readonly description: "Recurrence item scheduled date"; readonly format: "date"; readonly example: "2024-10-23"; readonly deprecated: false; }; readonly canBeCancelled: { readonly type: "boolean"; readonly description: "Whether the recurrence item can be cancelled"; readonly example: true; readonly deprecated: false; }; readonly recurrenceNumber: { readonly type: "integer"; readonly description: "Recurrence number"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly quantity: { readonly type: "integer"; readonly description: "Number of repetitions"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Recurrence value"; readonly example: 0.02; readonly deprecated: false; }; readonly refusalReasonDescription: { readonly type: "string"; readonly description: "Recurrence item refusal reason"; readonly deprecated: false; readonly example: null; }; readonly externalAccount: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleExternalAccountDTO"; }; }; }; export declare const ApiPixTransactionRecurringCheckoutScheduleGetItemResponseRecurringCheckoutSchedulePixItemStatusSchema: { readonly type: "string"; readonly description: "Recurrence item status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "CANCELLED", "REFUSED", "DONE"]; }; export declare const ApiPixTransactionRecurringCheckoutScheduleExternalAccountDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Receiver name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly financialInstitutionName: { readonly type: "string"; readonly description: "Payment institution name"; readonly example: "Example bank S.A"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "Receiver CPF or CNPJ"; readonly example: "***.456.789-**"; readonly deprecated: false; }; readonly pixKey: { readonly type: "string"; readonly description: "Receiver Pix key"; readonly example: "***.456.789-**"; readonly deprecated: false; }; }; readonly description: "Receiver information"; readonly deprecated: false; }; export declare const ApiPixTransactionRecurringCheckoutSchedulePathIdRequestDTOSchema: { readonly type: "object"; readonly properties: {}; }; export declare const ApiPixTransactionRecurringCheckoutScheduleGetResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique recurrence identifier in Asaas"; readonly example: "35363f6e-93e2-11ec-b9d9-96f4053b1bd4"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleStatus"; }; readonly origin: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleOrigin"; }; readonly value: { readonly type: "number"; readonly description: "Recurrence value"; readonly example: 0.02; readonly deprecated: false; }; readonly frequency: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleFrequency"; }; readonly quantity: { readonly type: "integer"; readonly description: "Number of repetitions"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly startDate: { readonly type: "string"; readonly description: "Recurrence start date"; readonly format: "date"; readonly example: "2024-09-18"; readonly deprecated: false; }; readonly finishDate: { readonly type: "string"; readonly description: "Recurrence finish date"; readonly format: "date"; readonly example: "2024-09-25"; readonly deprecated: false; }; readonly canBeCancelled: { readonly type: "boolean"; readonly description: "Whether the recurrence can be cancelled"; readonly example: true; readonly deprecated: false; }; readonly externalAccount: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleExternalAccountDTO"; }; }; }; export declare const ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleStatusSchema: { readonly type: "string"; readonly description: "Recurrence status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["AWAITING_CRITICAL_ACTION_AUTHORIZATION", "PENDING", "SCHEDULED", "CANCELLED", "DONE"]; }; export declare const ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleOriginSchema: { readonly type: "string"; readonly description: "Indicates the origin of the recurrence"; readonly example: "PIX"; readonly deprecated: false; readonly enum: readonly ["PIX"]; }; export declare const ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleFrequencySchema: { readonly type: "string"; readonly description: "Recurrence frequency"; readonly example: "WEEKLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "MONTHLY"]; }; export declare const ApiPixTransactionRecurringCheckoutScheduleListItemsResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly offset: { readonly type: "integer"; readonly description: "List starting element"; readonly format: "int64"; readonly example: 0; readonly deprecated: false; }; readonly limit: { readonly maximum: 100; readonly type: "integer"; readonly description: "Number of list elements (max: 100)"; readonly format: "int64"; readonly example: 10; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleGetItemResponseDTO"; }; }; }; }; export declare const ApiPixTransactionRecurringCheckoutScheduleListResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "list"; readonly deprecated: false; }; readonly hasMore: { readonly type: "boolean"; readonly description: "Indicates whether there is another page to be searched"; readonly example: false; readonly deprecated: false; }; readonly totalCount: { readonly type: "integer"; readonly description: "Total number of items for the filters entered"; readonly format: "int32"; readonly example: 2; readonly deprecated: false; }; readonly limit: { readonly type: "integer"; readonly description: "Number of objects per page"; readonly format: "int32"; readonly example: 10; readonly deprecated: false; }; readonly offset: { readonly type: "integer"; readonly description: "Position of the object from which the page should be loaded"; readonly format: "int32"; readonly example: 0; readonly deprecated: false; }; readonly data: { readonly type: "array"; readonly description: "List of objects"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPixTransactionRecurringCheckoutScheduleGetResponseDTO"; }; }; }; }; export declare const ApiPixTransactionRecurringCheckoutScheduleListRequestRecurringCheckoutScheduleStatusSchema: { readonly type: "string"; readonly description: "Filter by recurrence status"; readonly example: "AWAITING_CRITICAL_ACTION_AUTHORIZATION"; readonly deprecated: false; readonly enum: readonly ["AWAITING_CRITICAL_ACTION_AUTHORIZATION", "PENDING", "SCHEDULED", "CANCELLED", "DONE"]; }; export declare const ApiPaymentSaveWithCreditCardRequestDTOSchema: { readonly required: readonly ["customer", "billingType", "value", "dueDate", "remoteIp"]; readonly type: "object"; readonly properties: { readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentSaveWithCreditCardRequestBillingType"; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Payment amount"; readonly example: 129.9; readonly deprecated: false; }; readonly dueDate: { readonly required: readonly ["dueDate"]; readonly type: "string"; readonly description: "Payment due date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Payment description (max. 500 characters)"; readonly example: "Pedido 056984"; readonly deprecated: false; }; readonly daysAfterDueDateToRegistrationCancellation: { readonly type: "integer"; readonly description: "Days after registration cancellation deadline (only for bank slip)"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly installmentCount: { readonly type: "integer"; readonly description: "Number of installments (only in the case of installment payment)"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly totalValue: { readonly type: "number"; readonly description: "Enter the total amount of a charge that will be paid in installments (only in the case of an installment charge). If this field is sent, the installmentValue is not necessary, the calculation per installment will be automatic."; readonly deprecated: false; readonly example: null; }; readonly installmentValue: { readonly type: "number"; readonly description: "Value of each installment (only in the case of installment payment). Send this field if you want to define the value of each installment."; readonly deprecated: false; readonly example: null; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; readonly split: { readonly type: "array"; readonly description: "Split Settings"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiPaymentSplitRequestDTO"; }; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiCreditCardRequestDTO"; }; readonly creditCardHolderInfo: { readonly $ref: "#/components/schemas/ApiCreditCardHolderInfoRequestDTO"; }; readonly creditCardToken: { readonly type: "string"; readonly description: "Credit card token for using the credit card tokenization functionality"; readonly deprecated: false; readonly example: null; }; readonly authorizeOnly: { readonly type: "boolean"; readonly description: "Carry out only the Pre-Authorization of the payment"; readonly deprecated: false; readonly example: null; }; readonly remoteIp: { readonly required: readonly ["remoteIp"]; readonly type: "string"; readonly description: "IP from where the customer is making the purchase. Your server's IP must not be entered."; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiPaymentSaveWithCreditCardRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiPaymentLeanSaveWithCreditCardResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "payment"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique payment identifier in Asaas"; readonly example: "pay_080225913252"; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Payment creation date"; readonly format: "date"; readonly example: "2017-03-10"; readonly deprecated: false; }; readonly customerId: { readonly type: "string"; readonly description: "Unique identifier of the customer to whom the payment belongs"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly subscriptionId: { readonly type: "string"; readonly description: "Unique subscription identifier (when recurring billing)"; readonly deprecated: false; readonly example: null; }; readonly installmentId: { readonly type: "string"; readonly description: "Unique installment identifier (when billing in installments)"; readonly deprecated: false; readonly example: null; }; readonly paymentLinkId: { readonly type: "string"; readonly description: "Unique identifier of the payments link to which the payment belongs"; readonly deprecated: false; readonly example: null; }; readonly value: { readonly type: "number"; readonly description: "Payment amount"; readonly example: 129.9; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net value of the charge after discounting the Asaas fee"; readonly example: 124.9; readonly deprecated: false; }; readonly originalValue: { readonly type: "number"; readonly description: "Original amount of charge (filled when paid with interest and fine)"; readonly deprecated: false; readonly example: null; }; readonly interestValue: { readonly type: "number"; readonly description: "Calculated amount of interest and fine that must be paid after the charge is due"; readonly deprecated: false; readonly example: null; }; readonly description: { readonly type: "string"; readonly description: "Description of the payment"; readonly example: "Pedido 056984"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiPaymentLeanSaveWithCreditCardResponseBillingType"; }; readonly canBePaidAfterDueDate: { readonly type: "boolean"; readonly description: "Informs whether the charge can be paid after the due date (Only for bank slip)"; readonly example: true; readonly deprecated: false; }; readonly confirmedDate: { readonly type: "string"; readonly description: "Billing confirmation date"; readonly format: "date"; readonly example: "2017-03-10"; readonly deprecated: false; }; readonly pixTransactionId: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction to which the payment belongs"; readonly deprecated: false; readonly example: null; }; readonly status: { readonly $ref: "#/components/schemas/ApiPaymentLeanSaveWithCreditCardResponsePaymentStatus"; }; readonly dueDate: { readonly type: "string"; readonly description: "Payment due date"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly originalDueDate: { readonly type: "string"; readonly description: "Original due date upon creation of the payment"; readonly format: "date"; readonly example: "2017-06-10"; readonly deprecated: false; }; readonly paymentDate: { readonly type: "string"; readonly description: "Payment date on Asaas"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly customerPaymentDate: { readonly type: "string"; readonly description: "Date on which the customer paid the bank slip"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly installmentNumber: { readonly type: "integer"; readonly description: "Parcel number"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly deleted: { readonly type: "boolean"; readonly description: "Determines if the payment has been removed"; readonly example: false; readonly deprecated: false; }; readonly anticipated: { readonly type: "boolean"; readonly description: "Defines whether the charge was anticipated or is in the process of being anticipated"; readonly example: false; readonly deprecated: false; }; readonly anticipable: { readonly type: "boolean"; readonly description: "Determines whether the charge is anticipated"; readonly example: false; readonly deprecated: false; }; readonly creditDate: { readonly type: "string"; readonly description: "Billing Credit date"; readonly example: "2017-03-10"; readonly deprecated: false; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "URL of proof of confirmation, receipt, reversal or removal"; readonly deprecated: false; readonly example: null; }; readonly duplicatedPaymentId: { readonly type: "string"; readonly description: "Duplicate billing identifier (if true)"; readonly deprecated: false; readonly example: null; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineResponseDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestResponseDTO"; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiPaymentSaveWithCreditCardCreditCardDTO"; }; }; }; export declare const ApiPaymentLeanSaveWithCreditCardResponseBillingTypeSchema: { readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "TRANSFER", "DEPOSIT", "PIX"]; }; export declare const ApiPaymentLeanSaveWithCreditCardResponsePaymentStatusSchema: { readonly type: "string"; readonly description: "Payment status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE", "REFUNDED", "RECEIVED_IN_CASH", "REFUND_REQUESTED", "REFUND_IN_PROGRESS", "CHARGEBACK_REQUESTED", "CHARGEBACK_DISPUTE", "AWAITING_CHARGEBACK_REVERSAL", "DUNNING_REQUESTED", "DUNNING_RECEIVED", "AWAITING_RISK_ANALYSIS"]; }; export declare const ApiSubscriptionListPaymentsRequestPaymentStatusSchema: { readonly type: "string"; readonly description: "Filter by payment status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE", "REFUNDED", "RECEIVED_IN_CASH", "REFUND_REQUESTED", "REFUND_IN_PROGRESS", "CHARGEBACK_REQUESTED", "CHARGEBACK_DISPUTE", "AWAITING_CHARGEBACK_REVERSAL", "DUNNING_REQUESTED", "DUNNING_RECEIVED", "AWAITING_RISK_ANALYSIS"]; }; export declare const ApiInstallmentSaveWithCreditCardRequestDTOSchema: { readonly required: readonly ["installmentCount", "customer", "value", "billingType", "dueDate", "remoteIp"]; readonly type: "object"; readonly properties: { readonly installmentCount: { readonly required: readonly ["installmentCount"]; readonly type: "integer"; readonly description: "Number of installments"; readonly format: "int32"; readonly example: 3; readonly deprecated: false; }; readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_G7Dvo4iphUNk"; readonly deprecated: false; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Value of each installment"; readonly example: 100; readonly deprecated: false; }; readonly totalValue: { readonly type: "number"; readonly description: "Total installment amount"; readonly example: 150; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiInstallmentSaveWithCreditCardRequestBillingType"; }; readonly dueDate: { readonly required: readonly ["dueDate"]; readonly type: "string"; readonly description: "Due date of the first installment"; readonly format: "date"; readonly example: "2025-07-08"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Installment description (max. 500 characters)"; readonly example: "Installment 08652"; readonly deprecated: false; }; readonly postalService: { readonly type: "boolean"; readonly description: "Define whether the payment will be sent via post"; readonly example: false; readonly deprecated: false; }; readonly daysAfterDueDateToRegistrationCancellation: { readonly type: "integer"; readonly description: "Days after registration cancellation deadline (only for bank slip)"; readonly format: "int32"; readonly example: 1; readonly deprecated: false; }; readonly paymentExternalReference: { readonly type: "string"; readonly description: "Free search field"; readonly example: "056984"; readonly deprecated: false; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly splits: { readonly type: "array"; readonly description: "Split Settings"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiInstallmentSplitRequestDTO"; }; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiCreditCardRequestDTO"; }; readonly creditCardHolderInfo: { readonly $ref: "#/components/schemas/ApiCreditCardHolderInfoRequestDTO"; }; readonly creditCardToken: { readonly type: "string"; readonly description: "Credit card token for using the credit card tokenization functionality. If informed, the fields creditCard and creditCardHolderInfo are not mandatory."; readonly example: "a75a1d98-c52d-4a6b-a413-71e00b193c99"; readonly deprecated: false; }; readonly authorizeOnly: { readonly type: "boolean"; readonly description: "Carry out only the Pre-Authorization of the installment"; readonly deprecated: false; readonly example: null; }; readonly remoteIp: { readonly required: readonly ["remoteIp"]; readonly type: "string"; readonly description: "IP from where the customer is making the purchase. Your server's IP must not be entered."; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiInstallmentSaveWithCreditCardRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Payment billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiSubscriptionSaveWithCreditCardRequestDTOSchema: { readonly required: readonly ["customer", "billingType", "value", "nextDueDate", "cycle", "remoteIp"]; readonly type: "object"; readonly properties: { readonly customer: { readonly required: readonly ["customer"]; readonly type: "string"; readonly description: "Unique customer identifier in Asaas"; readonly example: "cus_0T1mdomVMi39"; readonly deprecated: false; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiSubscriptionSaveWithCreditCardRequestBillingType"; }; readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Subscription value"; readonly example: 19.9; readonly deprecated: false; }; readonly nextDueDate: { readonly required: readonly ["nextDueDate"]; readonly type: "string"; readonly description: "First payment due"; readonly format: "date"; readonly example: "2017-05-15"; readonly deprecated: false; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestRequestDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineRequestDTO"; }; readonly cycle: { readonly $ref: "#/components/schemas/ApiSubscriptionSaveWithCreditCardRequestCycle"; }; readonly description: { readonly type: "string"; readonly description: "Subscription description (max. 500 characters)"; readonly example: "Pro Plan Subscription"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "Deadline for payments to be due"; readonly format: "date"; readonly deprecated: false; readonly example: null; }; readonly maxPayments: { readonly type: "integer"; readonly description: "Maximum number of payments to be generated for this subscription"; readonly format: "int32"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Subscription identifier on your system"; readonly deprecated: false; readonly example: null; }; readonly split: { readonly type: "array"; readonly description: "Split information"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiSubscriptionSplitRequestDTO"; }; }; readonly callback: { readonly $ref: "#/components/schemas/ApiPaymentCallbackRequestDTO"; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiCreditCardRequestDTO"; }; readonly creditCardHolderInfo: { readonly $ref: "#/components/schemas/ApiCreditCardHolderInfoRequestDTO"; }; readonly creditCardToken: { readonly type: "string"; readonly description: "Credit card token for using the credit card tokenization functionality. If informed, the fields above are not mandatory."; readonly example: "a75a1d98-c52d-4a6b-a413-71e00b193c99"; readonly deprecated: false; }; readonly remoteIp: { readonly required: readonly ["remoteIp"]; readonly type: "string"; readonly description: "IP from where the customer is making the purchase. Your server's IP must not be entered."; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiSubscriptionSaveWithCreditCardRequestBillingTypeSchema: { readonly required: readonly ["billingType"]; readonly type: "string"; readonly description: "Billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "PIX"]; }; export declare const ApiSubscriptionSaveWithCreditCardRequestCycleSchema: { readonly required: readonly ["cycle"]; readonly type: "string"; readonly description: "Billing frequency"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiSubscriptionSaveWithCreditCardResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "subscription"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique subscription identifier in Asaas"; readonly example: "sub_VXJBYgP2u0eO"; readonly deprecated: false; }; readonly dateCreated: { readonly type: "string"; readonly description: "Subscription creation date"; readonly format: "date"; readonly example: "2017-03-17"; readonly deprecated: false; }; readonly customer: { readonly type: "string"; readonly description: "Unique customer identifier"; readonly example: "cus_0T1mdomVMi39"; readonly deprecated: false; }; readonly paymentLink: { readonly type: "string"; readonly description: "Unique identifier of the payments link to which the subscription belongs"; readonly deprecated: false; readonly example: null; }; readonly billingType: { readonly $ref: "#/components/schemas/ApiSubscriptionSaveWithCreditCardResponseBillingType"; }; readonly cycle: { readonly $ref: "#/components/schemas/ApiSubscriptionSaveWithCreditCardResponseCycle"; }; readonly value: { readonly type: "number"; readonly description: "Subscription value"; readonly example: 19.9; readonly deprecated: false; }; readonly nextDueDate: { readonly type: "string"; readonly description: "Due date of the next payment to be generated"; readonly format: "date"; readonly example: "2017-06-15"; readonly deprecated: false; }; readonly endDate: { readonly type: "string"; readonly description: "Deadline for payments to be due"; readonly format: "date"; readonly example: "2018-06-15"; readonly deprecated: false; }; readonly description: { readonly type: "string"; readonly description: "Subscription description"; readonly example: "Pro Plan Subscription"; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiSubscriptionSaveWithCreditCardResponseSubscriptionStatus"; }; readonly discount: { readonly $ref: "#/components/schemas/ApiPaymentDiscountDTO"; }; readonly fine: { readonly $ref: "#/components/schemas/ApiPaymentFineResponseDTO"; }; readonly interest: { readonly $ref: "#/components/schemas/ApiPaymentInterestResponseDTO"; }; readonly deleted: { readonly type: "boolean"; readonly description: "Informs if the subscription has been removed"; readonly example: false; readonly deprecated: false; }; readonly maxPayments: { readonly type: "integer"; readonly description: "Maximum number of payments to be generated for this subscription"; readonly format: "int32"; readonly example: 12; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Subscription identifier on your system"; readonly deprecated: false; readonly example: null; }; readonly split: { readonly type: "array"; readonly description: "Split information"; readonly deprecated: false; readonly items: { readonly $ref: "#/components/schemas/ApiSubscriptionSplitResponseDTO"; }; }; readonly creditCard: { readonly $ref: "#/components/schemas/ApiPaymentSaveWithCreditCardCreditCardDTO"; }; }; }; export declare const ApiSubscriptionSaveWithCreditCardResponseBillingTypeSchema: { readonly type: "string"; readonly description: "Billing type"; readonly example: "BOLETO"; readonly deprecated: false; readonly enum: readonly ["UNDEFINED", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "TRANSFER", "DEPOSIT", "PIX"]; }; export declare const ApiSubscriptionSaveWithCreditCardResponseCycleSchema: { readonly type: "string"; readonly description: "Billing frequency"; readonly example: "MONTHLY"; readonly deprecated: false; readonly enum: readonly ["WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "SEMIANNUALLY", "YEARLY"]; }; export declare const ApiSubscriptionSaveWithCreditCardResponseSubscriptionStatusSchema: { readonly type: "string"; readonly description: "Subscription status"; readonly example: "ACTIVE"; readonly deprecated: false; readonly enum: readonly ["ACTIVE", "EXPIRED", "INACTIVE"]; }; export declare const ApiTransferSaveInternalTransferRequestDTOSchema: { readonly required: readonly ["value", "walletId"]; readonly type: "object"; readonly properties: { readonly value: { readonly required: readonly ["value"]; readonly type: "number"; readonly description: "Amount to be transferred"; readonly example: 1000; readonly deprecated: false; }; readonly walletId: { readonly required: readonly ["walletId"]; readonly type: "string"; readonly description: "WalletId of the target account"; readonly example: "021c712-d963-4d86-a59d-031e7ac51a2e"; readonly deprecated: false; }; readonly externalReference: { readonly type: "string"; readonly description: "Transfer identifier in your system"; readonly deprecated: false; readonly example: null; }; }; }; export declare const ApiTransferSaveInternalTransferResponseDTOSchema: { readonly type: "object"; readonly properties: { readonly object: { readonly type: "string"; readonly description: "Object type"; readonly example: "transfer"; readonly deprecated: false; }; readonly id: { readonly type: "string"; readonly description: "Unique transfer identifier in Asaas"; readonly example: "777eb7c8-b1a2-4356-8fd8-a1b0644b5282"; readonly deprecated: false; }; readonly type: { readonly type: "string"; readonly description: "Type of transfer"; readonly example: "BANK_ACCOUNT"; readonly deprecated: false; readonly enum: readonly ["PIX", "TED", "INTERNAL"]; }; readonly dateCreated: { readonly type: "string"; readonly description: "Transfer request date"; readonly format: "date"; readonly example: "2019-05-02"; readonly deprecated: false; }; readonly value: { readonly type: "number"; readonly description: "Transfer amount"; readonly example: 1000; readonly deprecated: false; }; readonly netValue: { readonly type: "number"; readonly description: "Net value minus transfer fee"; readonly example: 0; readonly deprecated: false; }; readonly status: { readonly $ref: "#/components/schemas/ApiTransferSaveInternalTransferResponseTransferStatus"; }; readonly transferFee: { readonly type: "number"; readonly description: "Transfer rate"; readonly example: 0; readonly deprecated: false; }; readonly effectiveDate: { readonly type: "string"; readonly description: "Effective date"; readonly format: "date"; readonly example: "2019-05-02"; readonly deprecated: false; }; readonly scheduleDate: { readonly type: "string"; readonly description: "Schedule date"; readonly format: "date"; readonly example: "2019-05-02"; readonly deprecated: false; }; readonly endToEndIdentifier: { readonly type: "string"; readonly description: "Unique identifier of the Pix transaction at the Central Bank"; readonly deprecated: false; readonly example: null; }; readonly authorized: { readonly type: "boolean"; readonly description: "`false` when awaiting authorization via SMS Token"; readonly example: true; readonly deprecated: false; }; readonly failReason: { readonly type: "string"; readonly description: "Reason for transfer failure"; readonly deprecated: false; readonly example: null; }; readonly externalReference: { readonly type: "string"; readonly description: "Transfer identifier in your system"; readonly deprecated: false; readonly example: null; }; readonly transactionReceiptUrl: { readonly type: "string"; readonly description: "Proof of transfer will be available after the transfer is confirmed"; readonly deprecated: false; readonly example: null; }; readonly operationType: { readonly $ref: "#/components/schemas/ApiTransferSaveInternalTransferResponseTransferType"; }; readonly description: { readonly type: "string"; readonly description: "Transfer description"; readonly deprecated: false; readonly example: null; }; readonly recurring: { readonly type: "string"; readonly description: "Unique recurrence identifier in Asaas"; readonly deprecated: false; readonly example: null; }; readonly walletId: { readonly type: "string"; readonly description: "Unique wallet identifier to split charges or transfer between Asaas accounts"; readonly deprecated: false; readonly example: null; }; readonly account: { readonly $ref: "#/components/schemas/ApiTransferSaveInternalTransferAccountDTO"; }; }; }; export declare const ApiTransferSaveInternalTransferResponseTransferStatusSchema: { readonly type: "string"; readonly description: "Transfer status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "BANK_PROCESSING", "DONE", "CANCELLED", "FAILED"]; }; export declare const ApiTransferSaveInternalTransferResponseTransferTypeSchema: { readonly type: "string"; readonly description: "Transfer method"; readonly example: "TED"; readonly deprecated: false; readonly enum: readonly ["PIX", "TED", "INTERNAL"]; }; export declare const ApiTransferSaveInternalTransferAccountDTOSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "Target account name"; readonly example: "John Doe"; readonly deprecated: false; }; readonly cpfCnpj: { readonly type: "string"; readonly description: "CPF or CNPJ of the destination account"; readonly example: "***.143.689-**"; readonly deprecated: false; }; readonly agency: { readonly type: "string"; readonly description: "Target account branch code"; readonly example: "0001"; readonly deprecated: false; }; readonly account: { readonly type: "string"; readonly description: "Target account number"; readonly example: "2087"; readonly deprecated: false; }; readonly accountDigit: { readonly type: "string"; readonly description: "Target account digit"; readonly example: "2"; readonly deprecated: false; }; }; readonly description: "Target account basic information"; readonly deprecated: false; }; export declare const ApiInstallmentListPaymentsRequestPaymentStatusSchema: { readonly type: "string"; readonly description: "Filter by payment status"; readonly example: "PENDING"; readonly deprecated: false; readonly enum: readonly ["PENDING", "RECEIVED", "CONFIRMED", "OVERDUE", "REFUNDED", "RECEIVED_IN_CASH", "REFUND_REQUESTED", "REFUND_IN_PROGRESS", "CHARGEBACK_REQUESTED", "CHARGEBACK_DISPUTE", "AWAITING_CHARGEBACK_REVERSAL", "DUNNING_REQUESTED", "DUNNING_RECEIVED", "AWAITING_RISK_ANALYSIS"]; }; //# sourceMappingURL=schemas.gen.d.ts.map