> ## Documentation Index
> Fetch the complete documentation index at: https://docs.teceo.co/llms.txt
> Use this file to discover all available pages before exploring further.

# create accounts receivable installment



## OpenAPI

````yaml https://integration.teceo.co/aos post /v1/accounts-receivable
openapi: 3.0.0
info:
  title: teceo brand integrator API
  description: integrate your brand with teceo
  version: '1.0'
  contact: {}
servers:
  - url: /
security: []
tags: []
paths:
  /v1/accounts-receivable:
    post:
      tags:
        - 'Accounts Receivable:'
      summary: create accounts receivable installment
      operationId: AccountsReceivableController_create_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountsReceivableDTO'
      responses:
        '200':
          description: create accounts receivable installment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountsReceivableInstallmentResponseDTO'
        '400':
          description: >-
            response status code indicates that the server cannot or will not
            process the request due to something that is perceived to be a
            client error
        '403':
          description: >-
            client error status response code indicates that the server
            understood the request but refuses to authorize it
        '404':
          description: >-
            client error response code indicates that the server can't find the
            requested resource
        '409':
          description: >-
            an installment with the informed integrationCode already exists. the
            body carries code api.exception.accountsReceivable.alreadyExists
      security:
        - ApiKey: []
components:
  schemas:
    CreateAccountsReceivableDTO:
      type: object
      properties:
        customerCode:
          type: string
          description: code of the customer in the brand; provide this OR customerCnpj
          example: CUST-001
        customerCnpj:
          type: string
          description: CPF/CNPJ of the customer; provide this OR customerCode
          example: '05768567000126'
        invoiceId:
          type: string
          description: >-
            internal UUID of the related invoice; provide this OR
            invoiceAccessKey
          example: 00011f00-2224-4339-894a-f065d855ec70
        invoiceAccessKey:
          type: string
          description: >-
            access key of the related NF-e (44 digits); provide this OR
            invoiceId
          example: '41250605768567000126550030001387591780234910'
        receivableCode:
          type: string
          description: code of the receivable title
          example: TIT-5678
        integrationCode:
          type: string
          description: >-
            unique key of the installment within the brand. sending it again
            returns 409
          example: TIT-5678-1
        documentType:
          type: string
          description: >-
            classification of the title, returned and filterable on the listing.
            it does not change any processing
          enum:
            - INVOICE
            - CREDIT
            - DEBIT
            - CASH
            - CHECK
            - PIX
        installmentNumber:
          type: number
          description: position of the installment in the title, not checked for uniqueness
          example: 1
        expirationDate:
          type: string
          description: due date. only the date is stored, a value carrying time is rejected
          example: '2026-08-15'
          format: date
        value:
          type: number
          description: amount to be received
          example: 150.5
        paidValue:
          type: number
          description: amount already received
          example: 0
        status:
          type: string
          description: PAID requires paymentDate in the same payload
          enum:
            - PENDING
            - PAID
            - OVERDUE
        netValue:
          type: number
          description: net value of the installment
          example: 150.5
        grossValue:
          type: number
          description: gross value of the installment
          example: 160
        paymentDate:
          type: string
          description: >-
            payment date. only the date is stored, a value carrying time is
            rejected
          example: '2026-08-10'
          format: date
        discount:
          type: number
          description: discount value
          example: 9.5
        chargesValue:
          type: number
          description: interest and fine charges
          example: 0
        bankSlipBarcode:
          type: string
          description: bank slip barcode
        pixQrCode:
          type: string
          description: pix qr code
        digitableLine:
          type: string
          description: bank slip digitable line
      required:
        - receivableCode
        - integrationCode
        - documentType
        - installmentNumber
        - expirationDate
        - value
        - paidValue
        - status
        - netValue
        - grossValue
    AccountsReceivableInstallmentResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: use it later to attach the bank slip pdf to this installment
        integrationCode:
          type: string
          description: >-
            unique key of the installment within the brand, as sent in this
            request
        receivableCode:
          type: string
          description: code of the receivable title that groups the installments
        installmentNumber:
          type: number
          description: position of the installment in the title, not a unique key
        status:
          type: string
          description: >-
            status as sent in this request. only a later ERP import with the
            same integrationCode can change it
          enum:
            - PENDING
            - PAID
            - OVERDUE
      required:
        - id
        - integrationCode
        - receivableCode
        - installmentNumber
        - status
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: unique identifier access key. each brand has it own unique key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.