Sign in
estimate

Update estimate general informations

patch/v2/billing/estimate/{estimateId}/general-informations

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/v2/billing/estimate/{estimateId}/general-informations
  • Auth: HTTP bearer

Path parameters

estimateIdstring required

ID of the estimate to update

Request body

headerNotestring

Custom note to be displayed in the header of the billing

footerNotestring

Custom note to be displayed in the footer of the billing

generalTermsAndConditionsOfSalestring

General terms and conditions of sale to be included in the billing

mentionMediatorstring

Mention mediateur to be included in the billing

paymentMethodsPaymentMethod[]

Array of accepted payment methods for the billing

otherPaymentMethodstring

Other payment method

vatMention'not_subject' | 'second_hand_good' | 'art_object' | 'collection_antique' | 'travel_agency' | 'vat_not_applicable' | 'vat_not_applicable_2' | 'vat_exemption' | 'vat_exemption_eu_sale' | 'vat_exemption_eu_service' | 'vat_construction' | 'vat_psychologist' | 'vat_psychologist_2' | 'vat_reverse_charge' | 'vat_reverse_charge_2' | 'vat_reverse_charge_3' | 'vat_reverse_charge_4' | 'vat_reduced_rate' | 'vat_reduced_rate_2' | 'vat_article_261c_cgi' | 'vat_exemption_294_cgi'

Example request

{
  "headerNote": "Thank you for your business!",
  "footerNote": "Please pay within 30 days.",
  "generalTermsAndConditionsOfSale": "All goods remain our property until paid in full.",
  "mentionMediator": "Mention mediateur",
  "paymentMethods": [
    "transfer",
    "direct_debit"
  ],
  "otherPaymentMethod": "Lydia",
  "latePenalty": {
    "otherValue": "Trois fois le taux actuel en vigueur soit 6,2 %"
  },
  "lumpSumCompensation": {
    "otherValue": "Indemnité forfaitaire de 40€"
  },
  "discountAdvancePayment": {
    "otherValue": "Autre"
  }
}

Response

Estimate general informations updated successfully

idstring required
numberstring
titlestring

Title of the billing document

type'estimate' | 'invoice' | 'asset' | 'advance' | 'purchase_order' required
state'draft' | 'finalized' | 'signed' | 'refused' | 'paid' required
locale'fr' | 'en' | 'de' | 'it' | 'nl' | 'pt' | 'es' required
emittedAtnumber required
archivedAtnumber
lockedboolean
finalizableboolean required
testboolean required
isEditableboolean required
currencyCode'EUR' | 'GBP' | 'CHF' | 'USD' | 'AUD' | 'CAD' | 'JPY' | 'CNH' | 'CZK' | 'DKK' | 'BGN' | 'PLN' | 'HUF' | 'RON' | 'SEK' | 'NOK' | 'TRY' | 'BRL' | 'HKD' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'XPF' | 'XOF' | 'XAF' required

Preferred currency of the customer

lastDownloadAtnumber
createdAtnumber required
updatedAtnumber required
deliveryDatenumber
compatibilityVersion'V1' | 'V2' | 'V3' required
isDeletableboolean required
displayDeliveryAddressboolean required
finalizedAtnumber
lastSendByEmailAtnumber
themeIdstring

ID of the theme applied to this document when set

paymentDelay'at_reception' | 'end_of_month' | 'seven_days' | 'ten_days' | 'fifteen_days' | 'thirty_days' | 'thirty_days_end_of_month' | 'forty_five_days' | 'forty_five_days_end_of_month' | 'sixty_days' | 'sixty_days_end_of_month' | 'ninety_days' | 'ninety_days_end_of_month' | 'one_hundred_and_twenty_days' | 'other' required
expiredAtnumber required
refusedAtnumber
signedAtnumber
withElectronicSignatureboolean required
dueAtnumber
hasFinalInvoiceboolean required
includeDiscountDisbursementboolean required

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "number": "INV-2023-001",
  "title": "Invoice Title",
  "customer": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "legacyId": "123e4567",
    "firstname": "John",
    "lastname": "Doe",
    "phoneNumber": "+33 6 12 34 56 78",
    "emails": [
      "john.doe@example.com"
    ],
    "billingAddress": {
      "line1": "10 Rue Lecourbe",
      "line2": "Apartment 4B",
      "city": "Paris",
      "zipCode": "75015"
    },
    "deliveryAddress": {
      "line1": "10 Rue Lecourbe",
      "line2": "Apartment 4B",
      "city": "Paris",
      "zipCode": "75015"
    },
    "deliveryAddressIsSame": true,
    "language": "fr",
    "name": "John Doe",
    "commercialName": "Doe Enterprises",
    "siren": "123 456 789",
    "siret": "123 456 789 00012",
    "nafCode": "62.02A",
    "vatNumber": "FR12345678900",
    "token": "863aadf3-3cbe-4ba6-ad01-5c3edb05a669",
    "contactId": "123e4567-e89b-12d3-a456-426614174001",
    "organizationId": "123e4567-e89b-12d3-a456-426614174002",
    "isDefault": true
  },
  "emittedAt": 1617187200,
  "archivedAt": 1617360000,
  "opportunity": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Big Sale Opportunity"
  },
  "finalizable": true,
  "isEditable": true,
  "currency": {
    "currencyDate": 1617187200,
    "currencyRate": 1.2
  },
  "lastDownloadAt": 1617619200,
  "finalizeRequirements": [
    {
      "message": "Le montant de la somme des avoirs ne peut pas être supérieur au montant total de la facture.",
      "metadata": {
        "lines": [
          {
            "lineId": "66e7fb6afcc1f7272c627fcd",
            "driftHtCents": 3,
            "driftTtcCents": 7,
            "suggestedUnitAmountCents": 209479
          }
        ],
        "totalDriftHtCents": 3,
        "totalDriftTtcCents": 7
      }
    }
  ],
  "warnings": [
    {
      "title": "Titre du warning.",
      "message": "Message de warning en français."
    }
  ],
  "emitter": {
    "name": "John Doe Enterprise",
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+33 6 12 34 56 78",
    "commercialName": "Le magasin de John Doe",
    "siret": "12345678901234567890",
    "vatNumber": "FR12345678901234",
    "rcsNumber": "RCS Paris 552 100 554",
    "rsacNumber": "RSAC Paris 552 100 554",
    "sapAgreementNumber": "SAP123456789",
    "hasVat": true
  },
  "bankInformation": {
    "bic": "12345678901234567890",
    "iban": "12345678901234567890",
    "holder": "John Doe"
  },
  "billingLegals": {
    "headerNote": "Header note",
    "footerNote": "Footer note",
    "generalTermsAndConditionsOfSale": "General terms and conditions",
    "mentionMediator": "Mention mediateur",
    "paymentMethods": [
      "credit_card",
      "direct_debit"
    ],
    "otherPaymentMethod": "Lydia"
  },
  "createdAt": 1617619200,
  "updatedAt": 1617619200,
  "deliveryDate": 1617619200,
  "isDeletable": true,
  "displayDeliveryAddress": true,
  "finalizedAt": 1617619200,
  "lastSendByEmailAt": 1617446400,
  "themeId": "123e4567-e89b-12d3-a456-426614174000",
  "expiredAt": 1619865600,
  "refusedAt": 1619865600,
  "signedAt": 1619865600,
  "lines": [
    {
      "generatedId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "unitPrice": 50,
      "unitPriceHT": 50,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 2,
      "designation": "Consulting Services",
      "reference": "CONS-001",
      "description": "Detailed description of the service",
      "priceWithoutTaxBeforeDiscount": 100,
      "discountAmount": 1000,
      "discount": {
        "amount": 1000
      },
      "priceWithoutTaxAfterDiscount": 90,
      "vatAmount": 18,
      "priceTotalTax": 108,
      "convertedAmounts": {
        "priceWithoutTaxBeforeDiscount": 100,
        "discountAmount": 10,
        "priceWithoutTaxAfterDiscount": 90,
        "vatAmount": 18,
        "priceTotalTax": 108
      }
    }
  ],
  "total": {
    "amountWithoutTaxBeforeDiscount": 1100,
    "amountWithoutTaxAfterDiscount": 1000,
    "amountWithTaxAfterDiscount": 1200,
    "remainingAmountWithoutTax": 500,
    "remainingAmountWithTax": 600,
    "remainingAmountToBill": 600,
    "vatDetails": [
      {
        "amount": 200,
        "vatRate": 20
      }
    ],
    "discountAmount": 100,
    "convertedAmounts": {
      "amountWithoutTaxBeforeDiscount": 1100,
      "amountWithoutTaxAfterDiscount": 1000,
      "amountWithTaxAfterDiscount": 1200,
      "remainingAmountWithoutTax": 500,
      "remainingAmountWithTax": 600,
      "remainingAmountToBill": 600,
      "vatDetails": [
        {
          "amount": 200,
          "vatRate": 20
        }
      ],
      "discountAmount": 100,
      "billedAmountWithoutTax": 100,
      "billedAmountWithTax": 100,
      "remainingAmountWithoutTaxWithoutDisbursement": 100,
      "amountWithoutTaxBeforeDiscountWithoutDisbursement": 100
    },
    "billedAmountWithoutTax": 100,
    "billedAmountWithTax": 100,
    "amountWithoutTaxBeforeDiscountWithoutDisbursement": 100,
    "remainingAmountWithoutTaxWithoutDisbursement": 100
  },
  "discount": {
    "amount": 1000
  },
  "latePenalty": {
    "otherValue": "Trois fois le taux actuel en vigueur soit 6,2 %"
  },
  "lumpSumCompensation": {
    "otherValue": "Indemnité forfaitaire de 40€"
  },
  "discountAdvancePayment": {
    "otherValue": "Autre"
  },
  "displaySettings": {
    "displayFullName": true,
    "displayEmail": true,
    "displayPhoneNumber": true,
    "displaySAPAgreement": true,
    "displayLegalStatus": true,
    "displayRequiredMentionsProduct": true,
    "displayGoodForApproval": true,
    "displayMemberOfAnApprovedAssociation": true,
    "displayAbbyLogo": true,
    "displayTitle": true
  },
  "advances": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "number": "INV-2023-001",
      "title": "Invoice Title",
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "legacyId": "123e4567",
        "firstname": "John",
        "lastname": "Doe",
        "phoneNumber": "+33 6 12 34 56 78",
        "emails": [
          "john.doe@example.com"
        ],
        "billingAddress": {
          "line1": "10 Rue Lecourbe",
          "line2": "Apartment 4B",
          "city": "Paris",
          "zipCode": "75015"
        },
        "deliveryAddress": {
          "line1": "10 Rue Lecourbe",
          "line2": "Apartment 4B",
          "city": "Paris",
          "zipCode": "75015"
        },
        "deliveryAddressIsSame": true,
        "language": "fr",
        "name": "John Doe",
        "commercialName": "Doe Enterprises",
        "siren": "123 456 789",
        "siret": "123 456 789 00012",
        "nafCode": "62.02A",
        "vatNumber": "FR12345678900",
        "token": "863aadf3-3cbe-4ba6-ad01-5c3edb05a669",
        "contactId": "123e4567-e89b-12d3-a456-426614174001",
        "organizationId": "123e4567-e89b-12d3-a456-426614174002",
        "isDefault": true
      },
      "emittedAt": 1617187200,
      "archivedAt": 1617360000,
      "opportunity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Big Sale Opportunity"
      },
      "finalizable": true,
      "isEditable": true,
      "currency": {
        "currencyDate": 1617187200,
        "currencyRate": 1.2
      },
      "lastDownloadAt": 1617619200,
      "finalizeRequirements": [
        {
          "message": "Le montant de la somme des avoirs ne peut pas être supérieur au montant total de la facture.",
          "metadata": {
            "lines": [
              {
                "lineId": "66e7fb6afcc1f7272c627fcd",
                "driftHtCents": 3,
                "driftTtcCents": 7,
                "suggestedUnitAmountCents": 209479
              }
            ],
            "totalDriftHtCents": 3,
            "totalDriftTtcCents": 7
          }
        }
      ],
      "warnings": [
        {
          "title": "Titre du warning.",
          "message": "Message de warning en français."
        }
      ],
      "emitter": {
        "name": "John Doe Enterprise",
        "fullName": "John Doe",
        "email": "john.doe@example.com",
        "phone": "+33 6 12 34 56 78",
        "commercialName": "Le magasin de John Doe",
        "siret": "12345678901234567890",
        "vatNumber": "FR12345678901234",
        "rcsNumber": "RCS Paris 552 100 554",
        "rsacNumber": "RSAC Paris 552 100 554",
        "sapAgreementNumber": "SAP123456789",
        "hasVat": true
      },
      "bankInformation": {
        "bic": "12345678901234567890",
        "iban": "12345678901234567890",
        "holder": "John Doe"
      },
      "billingLegals": {
        "headerNote": "Header note",
        "footerNote": "Footer note",
        "generalTermsAndConditionsOfSale": "General terms and conditions",
        "mentionMediator": "Mention mediateur",
        "paymentMethods": [
          "credit_card",
          "direct_debit"
        ],
        "otherPaymentMethod": "Lydia"
      },
      "createdAt": 1617619200,
      "updatedAt": 1617619200,
      "deliveryDate": 1619865600,
      "displayDeliveryAddress": true,
      "finalizedAt": 1617619200,
      "lastSendByEmailAt": 1617446400,
      "themeId": "123e4567-e89b-12d3-a456-426614174000",
      "dueAt": 1619865600,
      "paidAt": 1617273600,
      "lastReminderSentAt": 1617532800,
      "isReminderActivated": true,
      "designation": "Advance 10% of 1000€",
      "isOnlinePaymentActivated": true,
      "description": "Advance description",
      "total": {
        "amountWithoutTaxBeforeDiscount": 1100,
        "amountWithoutTaxAfterDiscount": 1000,
        "amountWithTaxAfterDiscount": 1200,
        "remainingAmountWithoutTax": 500,
        "remainingAmountWithTax": 600,
        "remainingReconciliateAmount": 600,
        "vatDetails": [
          {
            "amount": 200,
            "vatRate": 20
          }
        ],
        "discountAmount": 100,
        "convertedAmounts": {
          "amountWithoutTaxBeforeDiscount": 1100,
          "amountWithoutTaxAfterDiscount": 1000,
          "amountWithTaxAfterDiscount": 1200,
          "remainingAmountWithoutTax": 500,
          "remainingAmountWithTax": 600,
          "remainingAmountToBill": 600,
          "vatDetails": [
            {
              "amount": 200,
              "vatRate": 20
            }
          ],
          "discountAmount": 100,
          "billedAmountWithoutTax": 100,
          "billedAmountWithTax": 100,
          "remainingAmountWithoutTaxWithoutDisbursement": 100,
          "amountWithoutTaxBeforeDiscountWithoutDisbursement": 100
        }
      },
      "discount": {
        "amount": 1000
      },
      "displaySettings": {
        "displayFullName": true,
        "displayEmail": true,
        "displayPhoneNumber": true,
        "displaySAPAgreement": true,
        "displayLegalStatus": true,
        "displayRequiredMentionsProduct": true,
        "displayGoodForApproval": true,
        "displayMemberOfAnApprovedAssociation": true,
        "displayAbbyLogo": true,
        "displayTitle": true
      },
      "advancePercentage": 10,
      "advanceAmount": 1000,
      "reminder": {
        "inCopy": true,
        "numberOfRemindersToSend": 3,
        "active": true,
        "recipients": [
          "john.doe@example.com"
        ]
      },
      "latePenalty": {
        "otherValue": "Trois fois le taux actuel en vigueur soit 6,2 %"
      },
      "lumpSumCompensation": {
        "otherValue": "Indemnité forfaitaire de 40€"
      },
      "discountAdvancePayment": {
        "otherValue": "Autre"
      },
      "includeDisbursement": true,
      "canceledAt": 1617619200
    }
  ],
  "advanceEstimateLines": {
    "advances": [
      {
        "value": 100,
        "mode": "AMOUNT",
        "paymentCondition": "ORDER"
      },
      {
        "value": 25,
        "mode": "PERCENTAGE",
        "paymentCondition": "SIGNATURE"
      }
    ],
    "totals": {
      "totalAmountWithoutTax": 350,
      "totalAmountWithTax": 350,
      "remainingTotalAmountWithoutTax": 350,
      "remainingTotalAmountWithTax": 350
    },
    "convertedTotals": {
      "totalAmountWithoutTax": 350,
      "totalAmountWithTax": 350,
      "remainingTotalAmountWithoutTax": 350,
      "remainingTotalAmountWithTax": 350
    }
  },
  "withElectronicSignature": true,
  "electronicSignature": {
    "id": "12345678901234567890",
    "canceledAt": 1617619200,
    "procedureId": "12345678901234567890",
    "magicLink": "https://magic-link.com",
    "signedAt": 1617619200,
    "refusedAt": 1617619200
  },
  "dueAt": 1619865600,
  "electronicSignatureRequirements": [
    {
      "name": "hasNonEmptyCustomerContact",
      "message": "Vous devez sélectionner un contact à votre organisation cliente pour pouvoir activer la signature en ligne."
    }
  ],
  "hasFinalInvoice": true,
  "includeDiscountDisbursement": true
}

Changes